diff --git a/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiDefinition.swagger.json b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiDefinition.swagger.json new file mode 100644 index 0000000000..d49a5c7c21 --- /dev/null +++ b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiDefinition.swagger.json @@ -0,0 +1,18347 @@ +{ + "swagger": "2.0", + "info": { + "title": "Fuxsy-ADSKFusionManagePaid", + "version": "1.0", + "description": "For more information, visit: www.fuxsy.eu", + "contact": { + "name": "Fuxsy s.r.o.", + "url": "http://fuxsy.eu/", + "email": "support@fuxsy.eu" + } + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "http://fuxsy.eu/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "http://fuxsy.eu/" + }, + { + "propertyName": "Categories", + "propertyValue": "Data;IT Operations" + } + ], + "host": "fusionmanagetaskrunnerapimanagement.azure-api.net", + "basePath": "/plm_paid-clone", + "schemes": [ + "https" + ], + "securityDefinitions": { + "Subscription key": { + "type": "apiKey", + "in": "header", + "name": "Ocp-Apim-Subscription-Key" + } + }, + "security": [ + { + "Subscription key": [] + } + ], + "paths": { + "/api/v3/groups": { + "get": { + "x-ms-summary": "Retrieves a list of groups.", + "description": "Retrieves a list of all groups available in the tenant.", + "operationId": "groupsList", + "summary": "Groups List", + "tags": [ + "groups" + ], + "parameters": [ + { + "name": "offset", + "in": "query", + "x-ms-summary": "Specifies the index to start retrieving items from a paginated result set.", + "description": "Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + }, + { + "name": "sort", + "in": "query", + "x-ms-summary": "Sorts the results alphabetically in ascending or descending order.", + "description": "Sorts the results alphabetically either ascending or descending depending on specified value.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "groups": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "exclusiveGroup": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "invariantName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "isSystemManaged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "longName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "mappedToOxygen": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "minUserCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "restrictIp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "shortName", + "minUserCount", + "exclusiveGroup", + "restrictIp", + "isSystemManaged", + "mappedToOxygen" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "204": { + "description": "204 - No Content" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "The request contains no authorization information.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/groups/{GroupID}": { + "get": { + "x-ms-summary": "Retrieve details about a group by GroupID.", + "description": "Retrieves detailed information about a specific group.", + "operationId": "groupsDetails", + "summary": "Groups Details", + "tags": [ + "groups" + ], + "parameters": [ + { + "name": "GroupID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the group to retrieve details.", + "description": "The ID of the group for which you want to retrieve details can be obtained through the GET Groups List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "exclusiveGroup": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "isSystemManaged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "mappedToOxygen": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "minUserCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "restrictIp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/groups/{GroupID}/users": { + "get": { + "x-ms-summary": "Retrieve a list of users in a group by GroupID.", + "description": "Retrieves a list of users and their details for a specific group.", + "operationId": "usersInGroup", + "summary": "Users In Group", + "tags": [ + "groups" + ], + "parameters": [ + { + "name": "GroupID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the group for which to retrieve details.", + "description": "The ID of the group for which you want to retrieve details can be obtained through the GET Groups List API call.", + "required": true, + "type": "integer" + }, + { + "name": "offset", + "in": "query", + "x-ms-summary": "Specifies the starting index for retrieving items in a paginated result set.", + "description": "Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "aboutMe": { + "type": "object" + }, + "active": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "address1": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "address2": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "analyticsId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "batchNotifyPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "cellular": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "city": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "consumeLicense": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "country": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "dashboardCharts": { + "type": "object" + }, + "dateFormat": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "delegations": { + "type": "array", + "items": { + "type": "string", + "example": "userId" + } + }, + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "displayNameExtended": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "enforce2fa": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "entitlement": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "externalAuthReservationToken": { + "type": "object" + }, + "externalAuthUserId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fax": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "firstName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "industry": { + "type": "object" + }, + "interfaceStyle": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "interfaceStyleMandated": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lastAccessTime": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastLicenseTimeIssued": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastLoginTime": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastMowUpdateDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastRecalculateStarted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastRecalculateUpdate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "ldapEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "licenseFeatureId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "licenseType": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "loginName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "mappedToOxygen": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "organization": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "phone": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "plmSearchCrawlerUser": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "postal": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "regularUser": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "reset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "signupUrl": { + "type": "object" + }, + "stateProv": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "surveyDone": { + "type": "object" + }, + "tenantAdmin": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "thumbnailPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "timezone": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "twoFactorAuthEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "uomPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "userActive": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "userId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "userInactive": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "userNumber": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "userStatus": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "wfNotifyPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "userId" + }, + "example": [ + "userId", + "loginName", + "delegations", + "dashboardCharts", + "displayName", + "firstName", + "lastName", + "active", + "reset", + "batchNotifyPref", + "wfNotifyPref", + "thumbnailPref", + "licenseType", + "title", + "phone", + "cellular", + "fax", + "email", + "address1", + "address2", + "city", + "stateProv", + "country", + "postal", + "timezone", + "organization", + "industry", + "aboutMe", + "uomPref", + "surveyDone", + "userNumber", + "dateFormat", + "displayNameExtended", + "externalAuthReservationToken", + "externalAuthUserId", + "plmSearchCrawlerUser", + "lastRecalculateUpdate", + "lastRecalculateStarted", + "lastMowUpdateDate", + "interfaceStyle", + "interfaceStyleMandated", + "entitlement", + "analyticsId", + "consumeLicense", + "licenseFeatureId", + "lastLicenseTimeIssued", + "enforce2fa", + "twoFactorAuthEnabled", + "ldapEnabled", + "signupUrl", + "regularUser", + "mappedToOxygen", + "tenantAdmin", + "userInactive", + "userStatus", + "userActive", + "id", + "__self__", + "urn" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/users": { + "get": { + "x-ms-summary": "Retrieve a list of users.", + "description": "Retrieves a list of all users in the tenant with the option to filter by status.", + "operationId": "usersList", + "summary": "Users List", + "tags": [ + "users" + ], + "parameters": [ + { + "name": "activeOnly", + "in": "query", + "x-ms-summary": "Indicates whether to show only active users.", + "description": "If set to true, shows only users who are currently active.", + "type": "string" + }, + { + "name": "mappedOnly", + "in": "query", + "x-ms-summary": "mappedOnly", + "description": "If set to true, shows only users who are mappedOnly", + "type": "string" + }, + { + "name": "sort", + "in": "query", + "x-ms-summary": "Sorts the results alphabetically in ascending or descending order.", + "description": "Sorts the results alphabetically either ascending or descending depending on specified value.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "users": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/users/{UserID}": { + "get": { + "x-ms-summary": "Retrieve user's details By UserID.", + "description": "Retrieves detailed information about the specified user. If @me is used, the API will return details about the user making the API call.", + "operationId": "userDetails", + "summary": "User Details", + "tags": [ + "users" + ], + "parameters": [ + { + "name": "UserID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the user to retrieve details.", + "description": "The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "aboutMe": { + "type": "object" + }, + "active": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "address1": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "address2": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "alerts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "acknowledged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "message": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "priority": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urgent": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted", + "type", + "urgent", + "priority", + "message", + "acknowledged" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "analyticsId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "batchNotifyPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "cellular": { + "type": "object" + }, + "city": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "consumeLicense": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "country": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "dashboardCharts": { + "type": "object" + }, + "dateFormat": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "delegations": { + "type": "object", + "properties": { + "items": { + "type": "string" + } + } + }, + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "displayNameExtended": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "enforce2fa": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "entitlement": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "externalAuthReservationToken": { + "type": "object" + }, + "externalAuthUserId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fax": { + "type": "object" + }, + "firstName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "groups": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "longName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "shortName" + }, + "example": [ + "shortName", + "longName", + "link", + "urn" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "industry": { + "type": "object" + }, + "interfaceStyle": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "interfaceStyleMandated": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lastAccessTime": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastLicenseTimeIssued": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastLoginTime": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastMowUpdateDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastRecalculateStarted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastRecalculateUpdate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "ldapEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "licenseFeatureId": { + "type": "object" + }, + "licenseType": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "loginName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "mappedToOxygen": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "organization": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "phone": { + "type": "object" + }, + "plmSearchCrawlerUser": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "postal": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "preferences": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "regularUser": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "reset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "showEnableFullAccess": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "signupUrl": { + "type": "object" + }, + "stateProv": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "surveyDone": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "tenantAdmin": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "thumbnailPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "timezone": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "twoFaEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "twoFactorAuthEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "uomPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "userActive": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "userId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "userInactive": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "userNumber": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "userStatus": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "wfNotifyPref": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/users/{UserID}/permissions": { + "get": { + "x-ms-summary": "Retrieve a list of user's permissions.", + "description": "Retrieves a list of all permissions assigned to a specific user.", + "operationId": "userPermissionsList", + "summary": "User list of Permissions", + "tags": [ + "users" + ], + "parameters": [ + { + "name": "UserID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the user for which to retrieve details.", + "description": "The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "permissions": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "name", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/users/{UserID}/permissions/{PermissionID}": { + "get": { + "x-ms-summary": "Retrieve user's permission details.", + "description": "Retrieves the permission details for a specific user within a specific workspace, based on the provided permission ID.", + "operationId": "userPermissionDetails", + "summary": "User Permission Detail", + "tags": [ + "users" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "UserID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the user to retrieve details.", + "description": "The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.", + "required": true, + "type": "string" + }, + { + "name": "PermissionID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the permission to retrieve details.", + "description": "The ID of the permission for which you want to retrieve details can be obtained through the GET Permission List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "longName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/permissions/": { + "get": { + "x-ms-summary": "Retrieve a list of permissions.", + "description": "Retrieves a list of all permissions available in the tenant.", + "operationId": "permissionsList", + "summary": "Permission List", + "tags": [ + "permissions" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "permissions": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "name", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/permissions/{PermissionID}": { + "get": { + "x-ms-summary": "Retrieve permission's details.", + "description": "Retrieves detailed information about a specific permission.", + "operationId": "permissionDetails", + "summary": "Permission Details", + "tags": [ + "permissions" + ], + "parameters": [ + { + "name": "PermissionID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the permission to retrieve details.", + "description": "The ID of the permission for which you want to retrieve details can be obtained through the GET Permission List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "longName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/11": { + "get": { + "x-ms-summary": "Retrieves a list of item's managed items.", + "description": "Retrieves a list of managed items associated with a specific item.", + "operationId": "managedItems", + "summary": "Item Managed Items", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "11 (ManagedItems)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "affectedItems": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "linkedFields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "uom": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "uomConverted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "item", + "type", + "linkedFields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "204": { + "description": "204 - No Content" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/attachments/{AttachmentID}": { + "get": { + "x-ms-summary": "Retrieve attachment's details.", + "description": "Retrieves detailed information about a specific attachment.", + "operationId": "attachmentDetails", + "summary": "Attachment Details", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Attachments" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "AttachmentID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the attachment to retrieve details.", + "description": "The ID of the attachment for which you want to retrieve details can be obtained through the GET Attachments List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fileUrl": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "403": { + "description": "403 - Operation forbidden", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "post": { + "x-ms-summary": "Create a new version of an existing attachment.", + "description": "Creates a new version of an existing attachment.", + "operationId": "attachmentCreateVersion", + "summary": "Attachment Create Version", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Attachments" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item containing the attachment.", + "description": "The ID of the item containing the attachment can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "AttachmentID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the attachment to create a new version.", + "description": "The ID of the attachment for which you want to create a new version can be obtained through the GET Attachments List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/user-views/{ViewID}": { + "get": { + "x-ms-summary": "Retrieve user view's details", + "description": "Retrieves detailed information about a specific user\u2019s view.", + "operationId": "userViewDetails", + "summary": "User View Details", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "UserView" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ViewID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the User View to retrieve details.", + "description": "The ID of the User View for which you want to retrieve details can be obtained through the GET User Views based access level API call.", + "required": true, + "type": "integer" + }, + { + "name": "asc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in ascending order.", + "description": "Specifies the field by which the results should be sorted in ascending order.", + "type": "string" + }, + { + "name": "desc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in descending order.", + "description": "Specifies the field by which the results should be sorted in descending order.", + "type": "string" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Specifies the page number of the results to retrieve.", + "description": "Specifies the page number of the results to retrieve. Used for paginating through large datasets.", + "type": "string" + }, + { + "name": "size", + "in": "query", + "x-ms-summary": "Specifies the number of items to return per page in a paginated response.", + "description": "Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "columns": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "index": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "index" + }, + "example": [ + "index", + "id", + "displayName" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "items": { + "type": "array", + "items": { + "type": "string" + } + }, + "pageNumber": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "pageSize": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "sortingColumns": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "index": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "order": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "index" + }, + "example": [ + "index", + "id", + "order" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "total": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/affected-items": { + "get": { + "x-ms-summary": "Retrieve a list of item's managed items.", + "description": "Retrieves a list of managed items associated with a specific item.", + "operationId": "itemManagedItemsList", + "summary": "Item Managed Items List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "AffectedItems" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item containing the managed item's tab.", + "description": "The ID of the item containing the managed item's tab can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "affectedItems": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "linkedFields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "uom": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "uomConverted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "item", + "type", + "linkedFields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "post": { + "x-ms-summary": "Associate an item to another item through managed items.", + "description": "Associates a new managed item with a specific item.", + "operationId": "createManagedItem", + "summary": "Item Managed Items Create", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "AffectedItems" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item containing the managed item's tab.", + "description": "The ID of the item containing the managed item's tab can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk affected items data in JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.affected.items.bulk+json", + "enum": [ + "application/vnd.autodesk.plm.affected.items.bulk+json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/user-views": { + "get": { + "x-ms-summary": "Retrieve a list of all user views.", + "description": "Retrieves a list of all user views (user-made filter of items inside a workspace).", + "operationId": "userViewsList", + "summary": "User Views based access level", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the user views.", + "description": "The ID of the workspace containing the user views can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "links": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/logs": { + "get": { + "x-ms-summary": "Retrieve item's log.", + "description": "Retrieves detailed log information for a specific item.", + "operationId": "itemLog", + "summary": "Item Log", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for which to retrieve a log.", + "description": "The ID of the item for which you want to retrieve a log of can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "offset", + "in": "query", + "x-ms-summary": "Specifies the starting index for retrieving items in a paginated result set.", + "description": "Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + }, + { + "name": "asc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in ascending order.", + "description": "Specifies the field by which the results should be sorted in ascending order. For example, using 'timeStamp' will sort the results based on the time they were created or modified.", + "type": "string" + }, + { + "name": "desc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in descending order.", + "description": "Specifies the field by which the results should be sorted in descending order. For example, using 'timeStamp' will sort the results based on the time they were created or modified.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "action": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "longName": { + "type": "object" + }, + "notifyPermission": { + "type": "object" + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "actionInvoker": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "details": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "array" + } + } + }, + "timeStamp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "status": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "description", + "action", + "actionInvoker", + "details", + "user", + "timeStamp" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "next": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}": { + "get": { + "x-ms-summary": "Retrieve item's details", + "description": "Retrieves detailed information about a specific item.", + "operationId": "itemDetails", + "summary": "Item Details", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "audit": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "bom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "currentState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "flatBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "itemLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "latestRelease": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lifecycle": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "milestones": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "nestedBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "owners": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "revertible": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "root": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "sections": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "sectionLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "title", + "sectionLocked", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "sectionsLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "whereUsed": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "workflowReference": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingHasChanged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingVersion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "put": { + "x-ms-summary": "Item Update Details", + "description": "Updates the details of a specific item, removing any details that are not specified.", + "operationId": "updateItemDetails", + "summary": "Item Update Details", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to update details.", + "description": "The ID of the item for which you want to update item details, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "patch": { + "x-ms-summary": "Item update Details - partial", + "description": "Partially updates the details of a specific item, retaining any unspecified details.", + "operationId": "updateItemDetailsPartial", + "summary": "Item update Details - partial", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to update details.", + "description": "The ID of the item for which you want to update item details, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/reports/{ReportID}": { + "get": { + "x-ms-summary": "Report Download", + "description": "Retrieves detailed information about a report/downloads the report", + "operationId": "reportDownload", + "summary": "Report Download", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ReportID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the report to download.", + "description": "The ID of the report that you want to download.", + "required": true, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Specifies the page number of the results to retrieve.", + "description": "Specifies the page number of the results to retrieve. Used for paginating through large datasets.", + "type": "string" + }, + { + "name": "asc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in ascending order.", + "description": "Specifies the field by which the results should be sorted in ascending order.", + "type": "string" + }, + { + "name": "desc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in descending order.", + "description": "Specifies the field by which the results should be sorted in descending order.", + "type": "string" + }, + { + "name": "size", + "in": "query", + "x-ms-summary": "Specifies the number of items to return per page in a paginated response.", + "description": "Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "columns": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "index": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "index" + }, + "example": [ + "index", + "id", + "displayName" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "id" + }, + "example": [ + "id", + "value" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "index": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "index" + }, + "example": [ + "index", + "item", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "pageNumber": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "pageSize": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "sortingColumns": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "index": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "order": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "index" + }, + "example": [ + "index", + "id", + "order" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "total": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/rest/v1/reports/{ReportID}": { + "get": { + "x-ms-summary": "Report Details", + "description": "Retrieves the complete configuration details of the report.", + "operationId": "reportDetails", + "summary": "Report Details", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "ReportID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the report to retrieve details.", + "description": "The ID of the report that you want to retrieve details of.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "reportDefinition": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "hasOrphanFields": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "isChartReport": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "modifiedDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "owner": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "workspaceId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "reportResult": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "columnKey": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "value" + }, + "example": [ + "value", + "label" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "row": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "entry": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fieldData": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "key": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "key" + }, + "example": [ + "key", + "fieldData" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "rowId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "rowId" + }, + "example": [ + "rowId", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "totalResultCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces": { + "get": { + "x-ms-summary": "Workspace List", + "description": "Retrieves a list of all workspaces in the tenant.", + "operationId": "workspaceList", + "summary": "Workspace List", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "category": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "displayOrder": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "icon": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "displayOrder": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "permissions": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "systemName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "title", + "systemName", + "category", + "urn", + "permissions", + "displayOrder", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/scripts/": { + "get": { + "x-ms-summary": "Script List", + "description": "Retrieves a list of all scripts within the tenant.", + "operationId": "scriptList", + "summary": "Script List", + "tags": [ + "scripts" + ], + "parameters": [ + { + "name": "orderBy", + "in": "query", + "x-ms-summary": "Specifies the field to order the results.", + "description": "Specifies the field by which the results should be ordered. For example, using 'scriptType' will order the results based on the type of script. This parameter works in conjunction with 'asc' or 'desc' to define the sorting direction.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "scripts": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "dependsOn": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "scriptType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "uniqueName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "version": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "uniqueName", + "displayName", + "scriptType", + "version", + "dependsOn" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/scripts/{ScriptID}": { + "get": { + "x-ms-summary": "Script Details", + "description": "Retrieves the content and details of a specific script.", + "operationId": "scriptDetails", + "summary": "Script Details", + "tags": [ + "scripts" + ], + "parameters": [ + { + "name": "ScriptID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the unique identifier of the script.", + "description": "The unique identifier of the script to retrieve or manipulate. This is a required parameter, and you must provide a valid ScriptID as an integer in the request path.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "code": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "dependsOn": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "scriptType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "uniqueName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "version": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/10": { + "get": { + "x-ms-summary": "Item Relationships list", + "description": "Retrieves a list of all relationship items associated with a specific item.", + "operationId": "itemRelationships", + "summary": "Item Relationships list", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "10 (Relationships)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item containing the relationships tab.", + "description": "The ID of the item containing the relationships tab can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "$ref": "#/definitions/ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse" + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/15": { + "get": { + "x-ms-summary": "Item Change Log", + "description": "Retrieves detailed information about changes made to a specific item.", + "operationId": "itemChangeLog", + "summary": "Item Change Log", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "15 (ChangeLog)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve a log.", + "description": "The ID of the item for which you want to retrieve a log of can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "action": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "longName": { + "type": "object" + }, + "notifyPermission": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "actionInvoker": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "details": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fieldName": { + "type": "object" + }, + "newValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "oldValue": { + "type": "object" + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "fieldName" + }, + "example": [ + "fieldName", + "type", + "oldValue", + "newValue" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "timeStamp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "status": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "description", + "action", + "actionInvoker", + "details", + "user", + "timeStamp" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "next": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/tabs": { + "get": { + "x-ms-summary": "Workspace item Tabs List", + "description": "Retrieves a list of all configured tabs for a specific workspace.", + "operationId": "workspaceItemTabsList", + "summary": "Workspace item Tabs List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve the tabs list.", + "description": "The ID of the item for which you want to retrieve a tabs list, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "tabs": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "sectionCounts": { + "type": "object" + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "name" + }, + "example": [ + "name", + "totalCount", + "sectionCounts" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/": { + "get": { + "x-ms-summary": "Workspace Configured View List", + "description": "Retrieves a list of all configured views for a specific workspace.", + "operationId": "workspaceConfiguredViewList", + "summary": "Workspace Configured View List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the configured view.", + "description": "The ID of the workspace containing the configured view can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of an item inside the workspace.", + "description": "The ID of an item inside the workspace, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items": { + "get": { + "x-ms-summary": "Workspace Items", + "description": "Retrieves a list of all items within a specific workspace.", + "operationId": "workspaceItemsList", + "summary": "Workspace Items", + "tags": [ + "Workspace/Item functions", + "Workspace" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk items data in JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.items.bulk+json", + "enum": [ + "application/json", + "application/vnd.autodesk.plm.items.bulk+json" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "audit": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "bom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "currentState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "flatBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "itemLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "latestRelease": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lifecycle": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "milestones": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "nestedBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "owners": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "root": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "sections": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "sectionLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "title", + "sectionLocked", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "sectionsLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "whereUsed": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "workflowReference": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingHasChanged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingVersion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "workspace", + "root", + "title", + "deleted", + "latestRelease", + "workingVersion", + "itemLocked", + "workflowReference", + "workingHasChanged", + "currentState", + "lifecycle", + "bom", + "nestedBom", + "flatBom", + "whereUsed", + "milestones", + "audit", + "owners", + "sectionsLink", + "sections" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "next": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "post": { + "x-ms-summary": "Item Create", + "description": "Creates a new item within a specific workspace.", + "operationId": "itemCreate", + "summary": "Item Create", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for item creation.", + "description": "The ID of the workspace in which you want to create an item, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "201 Created", + "headers": { + "Cache-Control": { + "type": "string" + }, + "Connection": { + "type": "string" + }, + "Content-Length": { + "type": "string" + }, + "Date": { + "type": "string" + }, + "Expires": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "Pragma": { + "type": "string" + }, + "Server": { + "type": "string" + }, + "Set-Cookie": { + "type": "string" + }, + "Strict-Transport-Security": { + "type": "string" + }, + "X-Correlation-Id": { + "type": "string" + }, + "X-Frame-Options": { + "type": "string" + }, + "X-XSS-Protection": { + "type": "string" + }, + "x-request-id": { + "type": "string" + } + } + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/search-results": { + "get": { + "x-ms-summary": "Search value in whole tenant", + "description": "Searches for a value across all items in the entire tenant.", + "operationId": "searchInTenant", + "summary": "Search value in whole tenant", + "tags": [ + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "query", + "in": "query", + "x-ms-summary": "Specifies the search term for querying tenant data.", + "description": "The search term to be used for querying the tenant's data.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + }, + { + "name": "sort", + "in": "query", + "x-ms-summary": "Specifies the sorting order for the results.", + "description": "Specifies the sorting order for the results. Use 'asc' for ascending and 'desc' for descending. Example: 'createdOn asc' for sorting by creation date in ascending order.", + "type": "string" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk items data in JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.items.bulk+json", + "enum": [ + "application/json", + "application/vnd.autodesk.plm.items.bulk+json" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "audit": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "bom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "currentState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "flatBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "itemLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "latestRelease": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lifecycle": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "milestones": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "nestedBom": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "owners": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "root": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "sections": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "sectionLocked": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "title", + "sectionLocked", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "sectionsLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "whereUsed": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "workflowReference": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingHasChanged": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workingVersion": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "workspace", + "root", + "title", + "deleted", + "latestRelease", + "workingVersion", + "itemLocked", + "workflowReference", + "workingHasChanged", + "currentState", + "lifecycle", + "bom", + "nestedBom", + "flatBom", + "whereUsed", + "milestones", + "audit", + "owners", + "sectionsLink", + "sections" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "204": { + "description": "204 - No Content" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/13/rows": { + "get": { + "x-ms-summary": "Item Grid Rows", + "description": "Retrieves a list of rows and fields for a specific item, including their values.", + "operationId": "itemGridRows", + "summary": "Item Grid Rows", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "13 (Grid)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "aggregations": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "rows": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "metaFieldTableBean": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataMap": { + "type": "object", + "properties": { + "properties": { + "type": "object" + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "rowData": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "rowID": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "rowData" + }, + "example": [ + "rowData", + "rowID", + "metaFieldTableBean" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/folders": { + "post": { + "x-ms-summary": "Attachment Folder Create", + "description": "Creates a new attachment folder for a specific item.", + "operationId": "attachmentCreateFolder", + "summary": "Attachment Folder Create", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Attachments", + "Folders" + ], + "parameters": [ + { + "name": "WorkspaceID", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "in": "path", + "x-ms-url-encoding": "single", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "x-ms-summary": "Specifies the ID of the item containing the attachment.", + "description": "The ID of the item containing the attachment can be obtained through the GET Item List API call.", + "in": "path", + "x-ms-url-encoding": "single", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "in": "header", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/attachments": { + "get": { + "x-ms-summary": "Retrieves a list of attachments.", + "description": "Retrieves a list of all attachments for a specific item.", + "operationId": "attachmentList", + "summary": "Attachment List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Attachments" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "asc", + "in": "query", + "x-ms-summary": "Specifies the field to sort results in ascending order.", + "description": "Specifies the field by which the results should be sorted in ascending order. For example, use 'name' to sort results by the name field in ascending order.", + "type": "string" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the format of bulk attachment data in JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.attachments.bulk+json", + "enum": [ + "application/vnd.autodesk.plm.attachments.bulk+json" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "attachments": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "created": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "timeStamp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "status": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "folder": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "markups": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "resourceName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "selfLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "size": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "status": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "thumbnails": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "extension": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fileType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "iconImage": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "viewable": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "url": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "version": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "selfLink" + }, + "example": [ + "selfLink", + "urn", + "name", + "url", + "thumbnails", + "id", + "description", + "size", + "version", + "status", + "type", + "resourceName", + "created", + "folder", + "markups" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + }, + "post": { + "x-ms-summary": "Create an attachment.", + "description": "Creates or uploads a new attachment for a specific item.", + "operationId": "attachmentCreateUpload", + "summary": "Attachment Create", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Attachments" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace to retrieve details.", + "description": "The ID of the workspace for which you want to retrieve details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item to retrieve details.", + "description": "The ID of the item for which you want to retrieve details can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/users/{UserID}/outstanding-work": { + "get": { + "x-ms-summary": "User Outstanding Work", + "description": "Retrieves outstanding work for the signed-in user via the API. The @me parameter is used to refer to the currently logged-in user, and it is not possible to choose a different user.", + "operationId": "userOutstandingWork", + "summary": "User Outstanding Work", + "tags": [ + "users" + ], + "parameters": [ + { + "name": "UserID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the user to retrieve details.", + "description": "The ID of the user for which you want to retrieve details can be obtained through the GET Users List API call.", + "required": true, + "type": "string", + "default": "@me", + "enum": [ + "@me" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "lastRecalculateStarted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "lastRecalculateUpdate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "outstandingWork": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "delegated": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "escalated": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "milestoneDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "milestoneStatus": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "workflowStateName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "workflowStateSetDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "workflowUser": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "status": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "escalated" + }, + "example": [ + "escalated", + "delegated", + "workflowStateSetDate", + "workflowStateName", + "item", + "workspace", + "workflowUser" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "recalculating": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/13/rows/{RowID}": { + "put": { + "x-ms-summary": "Item Grid Row Update", + "description": "Updates one or more rows for a specific item.", + "operationId": "itemGridRowUpdate", + "summary": "Item Grid Row Update", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "13 (Grid)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item containing the grid tab.", + "description": "The ID of the item containing the grid tab can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "RowID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the row to update.", + "description": "The ID of the row that you want to update.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/rest/v1/workspaces/{WorkspaceID}/items/{ItemID}/relationships": { + "get": { + "x-ms-summary": "Item Relationship Item detail V1", + "description": "Retrieves a list of relationships for a specific item.", + "operationId": "itemRelationshipsList", + "summary": "Item Relationship Item detail V1", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Relationships" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Indicates the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Indicates the ID of the item to retrieve relationship details.", + "description": "The ID of the item for which you want to retrieve relationship details of can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "page", + "in": "query", + "x-ms-summary": "Specifies the page number for result retrieval.", + "description": "Specifies the page number of the results to retrieve. Used for paginating through large datasets.", + "type": "string" + }, + { + "name": "size", + "in": "query", + "x-ms-summary": "Specifies the number of items per page in a paginated response.", + "description": "Specifies the number of items to return per page in a paginated response. This allows clients to control the size of the result set.", + "type": "string" + }, + { + "name": "sort", + "in": "query", + "x-ms-summary": "Specifies the field used to sort the results.", + "description": "Specifies the field by which to sort the results. Example: 'createdOn' for sorting by creation date.", + "type": "string" + }, + { + "name": "sortDirection", + "in": "query", + "x-ms-summary": "Specifies the sorting direction of the results.", + "description": "Specifies the sorting direction. Use 'ASC' for ascending and 'DESC' for descending. Example: 'ASC' to sort in ascending order.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "list": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "item-relationship": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "direction": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "details": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "dmsID": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "latest": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "lifecycleState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "effectivity": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "stateID": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "stateName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "timeStamp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "version": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "versionID": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "workflowState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "stateId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "stateName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "working": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "workspaceID": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "id": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "metaFields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "fieldData": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "key": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "key" + }, + "example": [ + "key", + "fieldData" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "uri": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "direction" + }, + "example": [ + "direction", + "type", + "description", + "item" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/where-used": { + "get": { + "x-ms-summary": "Item Where Used", + "description": "Retrieves a list of where the specific item is used.", + "operationId": "itemWhereUsed", + "summary": "Item Where Used", + "tags": [ + "Workspace", + "Item", + "bom", + "c" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item used in the BOM.", + "description": "The ID of the item used in BOM, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "config": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "bias": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "bomViewDate": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "viewDef": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "edges": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "child": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "depth": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "edgeId": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "edgeLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fields": { + "type": "array", + "items": { + "type": "string" + } + }, + "itemNumber": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "lastNode": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "parent": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "edgeId" + }, + "example": [ + "edgeId", + "parent", + "child", + "depth", + "itemNumber", + "fields", + "lastNode" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "nodes": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "bomItems": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "bomRoot": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "isSystemField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "value": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "title" + }, + "example": [ + "title", + "value", + "isSystemField" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "item": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "version": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "item" + }, + "example": [ + "item", + "bomItems", + "bomRoot", + "fields" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "root": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/print-views/{PrintViewID}": { + "get": { + "x-ms-summary": "Item PrintView", + "description": "Generates a print view of a specific item.", + "operationId": "itemPrintView", + "summary": "Item PrintView", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for creating a print view.", + "description": "The ID of the item for which you create a printview, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "PrintViewID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the Printview.", + "description": "The ID of the Printview, example: 'APV-123'", + "required": true, + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "hide": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "printName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/views/13/fields/{FieldID}": { + "get": { + "x-ms-summary": "Item Field Details", + "description": "Displays detailed information about specified field within an item grid.", + "operationId": "itemGridFieldDetails", + "summary": "Item Field Details", + "tags": [ + "Workspace/Item functions", + "Workspace", + "fields", + "Grid" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the items.", + "description": "The ID of the workspace containing the items, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "FieldID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the grid field for detail retrieval.", + "description": "The ID of the grid field for which you want to retrieve details.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "label": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { +"description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/views/13/fields": { + "get": { + "x-ms-summary": "Item List Fields", + "description": "Retrieves a list of all fields within the grid.", + "operationId": "itemGridFieldsList", + "summary": "Item List Fields", + "tags": [ + "Workspace/Item functions", + "Workspace", + "fields", + "Grid" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for grid field details retrieval.", + "description": "The ID of the workspace for which you want to retrieve grid field details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.meta+json", + "enum": [ + "application/vnd.autodesk.plm.meta+json", + "application/json" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object" + }, + "derived": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "displayLength": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "displayOrder": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "editability": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fieldLength": { + "type": "object" + }, + "fieldPrecision": { + "type": "object" + }, + "fieldValidators": { + "type": "object" + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "gridFieldAggregationInfo": { + "type": "object", + "properties": { + "properties": { + "type": "object" + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "label": { + "type": "object" + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "picklist": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "picklistFieldDefinition": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "unitOfMeasure": { + "type": "object" + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "validators": { + "type": "object" + }, + "visibility": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "visibleOnPreview": { + "type": "object" + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "name", + "description", + "type", + "defaultValue", + "unitOfMeasure", + "fieldLength", + "fieldPrecision", + "displayOrder", + "displayLength", + "editability", + "visibility", + "derived", + "picklist", + "validators", + "visibleOnPreview", + "gridFieldAggregationInfo", + "label", + "picklistFieldDefinition", + "fieldValidators" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "204": { + "description": "204 - No Content" + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/fields": { + "get": { + "x-ms-summary": "Item Details Fields List", + "description": "Retrieves a list of all fields available on the Item Details tab.", + "operationId": "itemDetailsFieldsList", + "summary": "Item Details Fields List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "fields" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for field details retrieval.", + "description": "The ID of the workspace for which you want to retrieve field details can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Accept", + "in": "header", + "x-ms-summary": "Specifies the media type expected in the response.", + "description": "Specifies the media type the client expects in the response. In this case, the client requests the response to be in the JSON format.", + "type": "string", + "default": "application/vnd.autodesk.plm.meta+json", + "enum": [ + "application/vnd.autodesk.plm.meta+json", + "application/json" + ] + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "defaultValue": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "derived": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "derivedFieldSource": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "derivedFields": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "title", + "type" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "displayLength": { + "type": "object" + }, + "displayOrder": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "editability": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "fieldLength": { + "type": "object" + }, + "fieldPrecision": { + "type": "object" + }, + "fieldValidators": { + "type": "array", + "items": { + "type": "string" + } + }, + "formulaField": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "label": { + "type": "object" + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "picklist": { + "type": "object" + }, + "picklistFieldDefinition": { + "type": "object" + }, + "pivotLink": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "unitOfMeasure": { + "type": "object" + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "validators": { + "type": "object" + }, + "visibility": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "visibleOnPreview": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "name", + "description", + "type", + "defaultValue", + "unitOfMeasure", + "fieldLength", + "fieldPrecision", + "displayOrder", + "displayLength", + "editability", + "visibility", + "derived", + "picklist", + "picklistFieldDefinition", + "validators", + "fieldValidators", + "visibleOnPreview", + "label" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/field-types/": { + "get": { + "x-ms-summary": "Item Field Types", + "description": "Provides a list of all available field types.", + "operationId": "itemDetailsFieldTypes", + "summary": "Item Field Types", + "tags": [ + "Workspace/Item functions", + "Workspace", + "fields" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "field-types": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/print-views": { + "get": { + "x-ms-summary": "Item PrintView List", + "description": "Retrieves a list of available print views.", + "operationId": "itemPrintViewsList", + "summary": "Item PrintView List", + "tags": [ + "Workspace/Item functions", + "Workspace", + "PrintViews" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for retrieving the print views list.", + "description": "The ID of the workspace for which you want to printviews list can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "asc", + "in": "query", + "x-ms-summary": "Indicates whether to sort results in ascending order.", + "description": "Indicates whether the results should be sorted in ascending order. Use 'true' for ascending or leave it blank for default sorting.", + "type": "string" + }, + { + "name": "desc", + "in": "query", + "x-ms-summary": "Indicates whether to sort results in descending order.", + "description": "Indicates whether the results should be sorted in descending order. Use 'true' for descending or leave it blank for default sorting.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "links": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "hidden": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "urn", + "title", + "deleted", + "type", + "hidden" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/scripts": { + "post": { + "x-ms-summary": "Script Create New", + "description": "Creates a new script of the specified type.", + "operationId": "scriptCreate", + "summary": "Script Create New", + "tags": [ + "scripts" + ], + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "required": true, + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "script post", + "headers": { + "Cache-Control": { + "type": "string" + }, + "Connection": { + "type": "string" + }, + "Content-Length": { + "type": "string" + }, + "Date": { + "type": "string" + }, + "Expires": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "Pragma": { + "type": "string" + }, + "Server": { + "type": "string" + }, + "Set-Cookie": { + "type": "string" + }, + "Strict-Transport-Security": { + "type": "string" + }, + "X-Correlation-Id": { + "type": "string" + }, + "X-Frame-Options": { + "type": "string" + }, + "X-XSS-Protection": { + "type": "string" + }, + "x-request-id": { + "type": "string" + } + } + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/lookups/{PicklistID}": { + "get": { + "x-ms-summary": "Picklist Details", + "description": "Retrieves details of picklist lookups.", + "operationId": "picklistLookups", + "summary": "Picklist Details", + "tags": [ + "Other" + ], + "parameters": [ + { + "name": "PicklistID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the Custom ID of the Picklist/Lookup for detail retrieval.", + "description": "The Custom ID of the Picklist/Lookup you want to retrieve details for.", + "required": true, + "type": "string" + }, + { + "name": "offset", + "in": "query", + "x-ms-summary": "Specifies the starting index for retrieving items in a paginated result set.", + "description": "Specifies the starting point or index from which to retrieve items in a paginated result set. Useful for skipping a certain number of items in the list.", + "type": "string" + }, + { + "name": "limit", + "in": "query", + "x-ms-summary": "Specifies the maximum number of items to return in the response.", + "description": "Specifies the maximum number of items to return in the response. This is used to limit the size of the result set.", + "type": "string" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "link" + }, + "example": [ + "link", + "title" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/13/rows/": { + "post": { + "x-ms-summary": "Item Create Row", + "description": "Creates a new row for a specific item within the grid.", + "operationId": "itemCreateGridRow", + "summary": "Item Create Row", + "tags": [ + "workspaces > {workspaceId} > views > 13", + "13 (Grid)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for creating a grid row.", + "description": "The ID of the item for which you want to create a grid row, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "Content-Type", + "in": "header", + "x-ms-summary": "Indicates the media type of the request body.", + "description": "Indicates the media type of the request body. In this case, the request body is expected to be in JSON format.", + "type": "string", + "default": "application/json", + "enum": [ + "application/json" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "201": { + "description": "201 - Created" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/workflows/1/transitions": { + "get": { + "x-ms-summary": "Workspace List Transitions", + "description": "Retrieves a list of available transitions for a specific workspace.", + "operationId": "workspaceTransitionslist", + "summary": "Workspace List Transitions", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for retrieving the transition list.", + "description": "The ID of the workspace for which you want to retrieve a list of transition can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of an item inside the workspace.", + "description": "The ID of an item inside the workspace, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "actionScript": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "approvers": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "array" + } + } + }, + "comments": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "customLabel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "delegatorUsers": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "array" + } + } + }, + "escalationPermission": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "fromState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "hidden": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "ignoreEscalatedPreconditions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "labelPositionA": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "labelPositionB": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "notifyPerformers": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "passwordEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "permission": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "points": { + "type": "object" + }, + "sendEmail": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "showInOutstanding": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "toState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "name", + "customLabel", + "sendEmail", + "showInOutstanding", + "notifyPerformers", + "passwordEnabled", + "ignoreEscalatedPreconditions", + "comments", + "workspace", + "fromState", + "toState", + "permission", + "escalationPermission", + "actionScript", + "delegatorUsers", + "labelPositionA", + "labelPositionB", + "hidden", + "points", + "approvers" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/workflows/1/transitions": { + "get": { + "x-ms-summary": "Transitions available", + "description": "Retrieves a list of available transitions for a specific item based on the logged-in user.", + "operationId": "itemTransitionsAvailable", + "summary": "Transitions available", + "tags": [ + "Workspace/Item functions", + "Workspace" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for retrieving available transitions.", + "description": "The ID of the workspace for which you want to retrieve a list of available transitions, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "actionScript": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "approvers": { + "type": "array", + "items": { + "type": "string" + } + }, + "comments": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "conditionScript": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "customLabel": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "delegatorUsers": { + "type": "array", + "items": { + "type": "string" + } + }, + "escalationPermission": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "fromState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "hidden": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "ignoreEscalatedPreconditions": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "labelPositionA": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "labelPositionB": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "notifyPerformers": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "passwordEnabled": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "permission": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "points": { + "type": "object" + }, + "sendEmail": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "showInOutstanding": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "toState": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "validationScript": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "workspace": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "type": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "name", + "customLabel", + "sendEmail", + "showInOutstanding", + "notifyPerformers", + "passwordEnabled", + "ignoreEscalatedPreconditions", + "comments", + "workspace", + "toState", + "permission", + "escalationPermission", + "delegatorUsers", + "labelPositionA", + "labelPositionB", + "hidden", + "points", + "approvers" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/{ViewID}": { + "get": { + "x-ms-summary": "Items Tab Overview", + "description": "Retrieves a list of records and fields for a specific tab.", + "operationId": "itemTabOverview", + "summary": "Items Tab Overview", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for retrieving records and fields for a tab/view.", + "description": "The ID of the item for which you want to retrieve a list of records and fields for a specific tab/view, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ViewID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the tab/view for details retrieval.", + "description": "The ID of the tab/view for which you want to retrieve details.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK viewID15", + "headers": { + "Cache-Control": { + "type": "string" + }, + "Connection": { + "type": "string" + }, + "Content-Encoding": { + "type": "string" + }, + "Date": { + "type": "string" + }, + "ETag": { + "type": "string" + }, + "Expires": { + "type": "string" + }, + "Pragma": { + "type": "string" + }, + "Server": { + "type": "string" + }, + "Set-Cookie": { + "type": "string" + }, + "Strict-Transport-Security": { + "type": "string" + }, + "Transfer-Encoding": { + "type": "string" + }, + "Vary": { + "type": "string" + }, + "X-Correlation-Id": { + "type": "string" + }, + "X-Frame-Options": { + "type": "string" + }, + "X-XSS-Protection": { + "type": "string" + }, + "x-request-id": { + "type": "string" + } + }, + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "first": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "items": { + "type": "object", + "properties": { + "items": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "__self__": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "action": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "longName": { + "type": "object" + }, + "notifyPermission": { + "type": "object" + }, + "shortName": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "actionInvoker": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "description": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "details": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "array" + } + } + }, + "timeStamp": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "email": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "image": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "large": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "medium": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "small": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "status": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "urn": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + } + }, + "required": { + "type": "array", + "items": { + "type": "string", + "example": "__self__" + }, + "example": [ + "__self__", + "urn", + "description", + "action", + "actionInvoker", + "details", + "user", + "timeStamp" + ] + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "type": { + "type": "string", + "example": "array" + } + } + }, + "last": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "count": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "deleted": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "boolean" + } + } + }, + "link": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + }, + "title": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "string" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + }, + "limit": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "offset": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + }, + "totalCount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integer" + } + } + } + } + }, + "type": { + "type": "string", + "example": "object" + } + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "403": { + "description": "403 Forbidden", + "examples": { + "application/json": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + } + } + }, + "500": { + "description": "500 Internal Server Error", + "examples": { + "application/json": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/workflows/{WorkflowID}/transitions/": { + "post": { + "x-ms-summary": "Item Transition", + "description": "Performs a transition on a specific item. Returns 403 even when successful.", + "operationId": "itemTransition", + "summary": "Item Transition", + "tags": [ + "Item", + "Workspace", + "Workspace/Item functions" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for performing a transition.", + "description": "The ID of the item on which you want to perform a transition, can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "WorkflowID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workflow transition to perform.", + "description": "The ID of the workflow transition that you want to perform.", + "required": true, + "type": "integer" + }, + { + "name": "content-location", + "in": "header", + "x-ms-summary": "Specifies the location of the resource or content.", + "description": "Specifies the location of the resource or content. This must be a valid URL or path to where the content is hosted or retrieved from.", + "required": true, + "type": "string" + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "Accepted" + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "403": { + "description": "403 - Operation forbidden", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 403, + "errors": [ + "FORBIDDEN" + ], + "message": "Unable to transition to 1234. Transition not a valid for current item state." + } + } + }, + "415": { + "description": "415 - Unsupported media type", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/sections": { + "get": { + "x-ms-summary": "Item Sections list", + "description": "Retrieves a list of all sections on the Item Details tab.", + "operationId": "itemDetailSections", + "summary": "Item Sections list", + "tags": [ + "Workspace/Item functions", + "Workspace" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace for retrieving item details sections.", + "description": "The ID of the workspace for which you want to retrieve item details sections configuration, can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 OK", + "schema": { + "$ref": "#/definitions/200_sections" + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "Object or Item not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { + "description": "500 Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + }, + "/api/v3/workspaces/{WorkspaceID}/items/{ItemID}/views/10/": { + "post": { + "x-ms-summary": "Item Relationship Item Create", + "description": "Creates a new relationship for a specific item.", + "operationId": "itemCreateRelationships", + "summary": "Item Relationship Item Create", + "tags": [ + "Workspace/Item functions", + "Workspace", + "Item", + "Views", + "10 (Relationships)" + ], + "parameters": [ + { + "name": "WorkspaceID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the workspace containing the item.", + "description": "The ID of the workspace containing the item can be obtained through the GET Workspace List API call.", + "required": true, + "type": "integer" + }, + { + "name": "ItemID", + "in": "path", + "x-ms-url-encoding": "single", + "x-ms-summary": "Specifies the ID of the item for creating a new relationship.", + "description": "The ID of the item for which you create a new relationship (link it with another item), can be obtained through the GET Item List API call.", + "required": true, + "type": "integer" + }, + { + "name": "content-location", + "in": "header", + "x-ms-summary": "Specifies the location of a specific item within a workspace.", + "description": "Specifies the location of a specific item within a workspace. The value contains placeholders like :WorkspaceID and :ItemID, which need to be replaced with actual IDs.", + "type": "string", + "default": "/api/v3/workspaces/:WorkspaceID/items/:ItemID/views/10/linkable-items/:ItemID", + "enum": [ + "/api/v3/workspaces/:WorkspaceID/items/:ItemID/views/10/linkable-items/:ItemID" + ] + }, + { + "name": "request123", + "in": "body", + "schema": { + "$ref": "#/definitions/request123" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "200 - Operation success" + }, + "400": { + "description": "400 - Bad request", + "examples": { + "application/json": { + "errorCode": "string", + "message": "string", + "params": {}, + "url": {}, + "errorClass": "string" + } + } + }, + "401": { + "description": "401 - No valid bearer token found", + "examples": { + "application/json": { + "errorCode": "SEC_UNAUTHORIZED", + "message": "No valid bearer token found.", + "params": null, + "url": null, + "errorClass": "APIError" + } + } + }, + "404": { + "description": "404 - Not found", + "examples": { + "application/json": { + "statusCode": 0, + "errors": [ + "string" + ], + "message": "string" + } + } + }, + "500": { +"description": "500 - Internal Server Error", + "examples": { + "application/json": { + "statusCode": 0, + "message": "string", + "activityId": "string" + } + } + } + } + } + } + }, + "definitions": { + "400": { + "type": "object", + "properties": { + "errorCode": { + "type": "string" + }, + "message": { + "type": "string" + }, + "params": {}, + "url": {}, + "errorClass": { + "type": "string" + } + } + }, + "401": { + "type": "object", + "properties": { + "errorCode": { + "type": "string" + }, + "message": { + "type": "string" + }, + "params": {}, + "url": {}, + "errorClass": { + "type": "string" + } + } + }, + "403": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "415": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "500": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "message": { + "type": "string" + }, + "activityId": { + "type": "string" + } + } + }, + "200_sections": { + "type": "array", + "items": { + "required": [ + "name", + "description", + "type", + "displayOrder", + "sectionType", + "fields", + "sectionLocked", + "pimSection", + "__self__", + "urn", + "matrices" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "type": { + "type": "string" + }, + "displayOrder": { + "type": "integer" + }, + "sectionType": { + "type": "string" + }, + "fields": { + "type": "array", + "items": { + "required": [ + "link", + "urn", + "deleted", + "type" + ], + "type": "object", + "properties": { + "link": { + "type": "string" + }, + "urn": { + "type": "string" + }, + "title": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + } + }, + "sectionLocked": { + "type": "boolean" + }, + "pimSection": { + "type": "boolean" + }, + "__self__": { + "type": "string" + }, + "urn": { + "type": "string" + }, + "matrices": { + "type": "array", + "items": { + "required": [ + "__self__", + "urn", + "width", + "height", + "columnNames", + "rowNames", + "fields" + ], + "type": "object", + "properties": { + "__self__": { + "type": "string" + }, + "urn": { + "type": "string" + }, + "width": { + "type": "integer" + }, + "height": { + "type": "integer" + }, + "columnNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "rowNames": { + "type": "array", + "items": { + "type": "string" + } + }, + "fields": { + "type": "array", + "items": { + "type": "array", + "items": { + "required": [ + "link", + "urn", + "title", + "deleted", + "type" + ], + "type": "object", + "properties": { + "link": { + "type": "string" + }, + "urn": { + "type": "string" + }, + "title": { + "type": "string" + }, + "deleted": { + "type": "boolean" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "404_node": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "404_workspace": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "404_not_found": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "404_item": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "create_row": { + "type": "object", + "properties": { + "rowData": { + "type": "array", + "items": { + "required": [ + "__self__", + "value", + "isSystemField" + ], + "type": "object", + "properties": { + "__self__": { + "type": "string" + }, + "value": { + "type": "string" + }, + "isSystemField": { + "type": "boolean" + } + } + } + } + } + }, + "500_attachment_id": { + "type": "object", + "properties": { + "errorCode": { + "type": "string" + }, + "message": { + "type": "string" + }, + "params": {}, + "url": {}, + "errorClass": { + "type": "string" + } + } + }, + "create_attachment": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "properties": { + "type": "object", + "properties": { + "description": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "name": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + }, + "folder": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "properties": { + "type": "object", + "properties": { + "name": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + } + } + } + }, + "resourceName": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + } + } + } + } + } + }, + "403_transitions": { + "type": "object", + "properties": { + "statusCode": { + "type": "integer" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + }, + "message": { + "type": "string" + } + } + }, + "ApiV3Workspaces-WorkspaceID-Items-ItemID-Views10Get200ApplicationJsonResponse": { + "type": "array", + "items": { + "type": "string" + } + }, + "request123": { + "example": {} + } + }, + "tags": [ + { + "name": "users" + }, + { + "name": "fields" + }, + { + "name": "scripts" + }, + { + "name": "groups" + }, + { + "name": "permissions" + }, + { + "name": "Auth" + }, + { + "name": "Workspace/Item functions" + }, + { + "name": "Workspace" + }, + { + "name": "Item" + }, + { + "name": "Views" + }, + { + "name": "10 (Relationships)" + }, + { + "name": "11 (ManagedItems)" + }, + { + "name": "13 (Grid)" + }, + { + "name": "15 (ChangeLog)" + }, + { + "name": "Attachments" + }, + { + "name": "Relationships" + }, + { + "name": "bom" + }, + { + "name": "UserView" + }, + { + "name": "AffectedItems" + }, + { + "name": "Grid" + }, + { + "name": "PrintViews" + }, + { + "name": "Other" + }, + { + "name": "Folders" + } + ] +} diff --git a/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiProperties.json b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiProperties.json new file mode 100644 index 0000000000..62e9d220d8 --- /dev/null +++ b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/apiProperties.json @@ -0,0 +1,9 @@ +{ + "properties": { + "connectionParameters": {}, + "iconBrandColor": "#da3b01", + "capabilities": [], + "publisher": "Fuxsy.eu", + "stackOwner": "Autodesk" + } +} diff --git a/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/readme.md b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/readme.md new file mode 100644 index 0000000000..4999e26556 --- /dev/null +++ b/independent-publisher-connectors/Fuxsy-AutodeskFusionManage/readme.md @@ -0,0 +1,165 @@ +# Fuxsy-AutodeskFusionManage +The Fuxsy-Autodesk Fusion Manage (PLM) Connector is a custom integration solution developed by Fuxsy s.r.o. It bridges Autodesk Fusion Manage (PLM) and Microsoft Power Platform, two powerful low-code process platforms. +This connector enhances Autodesk PLM's capabilities by leveraging features provided by Microsoft Power Platform, including: +* MS Power Automate: Automate processes and functions in Autodesk PLM such as PDF publishing and task scheduling. +* MS Power Apps: Create your own custom applications integrated with Autodesk PLM. +* MS PowerBi: Access Autodesk PLM data within a comprehensive reporting system. +* MS Sharepoint: Manage Autodesk PLM data and processes within SharePoint. + +## Publisher: Fuxsy s.r.o. + +## Prerequisites +You must be administrator of tenat to be able integrate Autodesk Fusion Managage 360 tenant within MS Power Platform. +Integration doesnt work for Participant access. It works only for Professional & Enterprise license. + +##Supported Operatins +In order to get access to both, free & paid functions you will have to meet all of the Prerequisite described above and have licenses from us. + +Free PLM Connector functions +### Get - Workspace list +Retrieve all workspaces available in your Autodesk Fusion Manage Tenant + +### Get - Item list: +Retrieve a list of all items in specified workspace. + +### Get - Item Detail +Retrieve all fields, sections, and additional information for a specified item in defined workspace. + +### Get - Report Details +Retrieve details from defined report. + +### Get - Search Items +Search for items based on specified values. + +Paid PLM Connector functions +### Get Groups & Users & Permissions +Get all informations from Users, Groups and Permissions + +### Get Workpsace items, Views +Get all items in worskpace also within custom views + +### Get - Search in Tenant or Workspace +Posibility to seach any object based on any string in whole Fusion Manage Tenant + +### Get - Item logs, Detai, Fields, Values, Worflow +Get all informations about Item it self, Fileds, Values, Seccions and workflow also within history. + +### Post - Item Create Row +Posibility to create Item in defined workspace. For more informations go below in frequently asked Questions. + +### Put - Item Update Details +Funcion for update existing item within whole or filed update. + +### Post - Item Managed Items Create +Posibility to create new Item within link in Manage tab + +### Post - Item Relationship Item Create +Posibility to create new Item within link in Relationship tab + +### Post - Item Transition +Posibility to change state of item based on configured workflow. + +### Get - Item Grid details +Get all informations from Grid tab from item + +### Post - Item Grid Create +Post informations in to Item Grid tab to create new row within fields +### Put - Item Grid Update +Update fileds or row on item in Grid tab + +### Post - Attachment Create +Create new Attachment as file for item + +### Post - Attachment Create Version +Create new version file of existing Attachment on Item + +### Post - Attachment Folder Create +Create new folder for Attachment for defined Item + +### Post - Script Create New +Postibilities to create new script. +Upcate existing script is not available in Fusion over API + +### Get - All Reports +Get list of all reports available in tenant + +### Get - Reports details +Get all details of specified report + +### Get - Item Print View +Get details of created Pring View for specific Item. + +### Get - Picklis & Picklist Values +Get all picklist and values available in Fusin Manage tenant + +## Obtaining Credentials +1) Obtaining Autodesk Forge app connector +To be able integrate your Fusion Manage tenant with third-party apps, you need to generate a special set of integration credentials as part of Autodesk's standard security requirements. +For more details, visit the Autodesk Forge documentation: https://aps.autodesk.com/en/docs/oauth/v2/tutorials/create-app/ + +2) Enabling integration of ClientID for your Fusion Manage Tenant +Once you have generated ClientID & ClientSecret inside of Autodesk Forge App, you must add these credentials to your Fusion Manage in order to enable tenant integration. +More information can be found here: https://help.autodesk.com/view/PLM/ENU/?guid=FLC_RestAPI_v3_API_2_legged_Tutorial_html + +3) Obtaining a Fuxsy PLM Connector Subscription key +Send us an email at: support@fuxsy.eu + - Subject : Fuxsy PLM Connector - Subscription key + - Email body: + - Tenant name : "YourTenantName.autodeskplm360.net" + - Email address : Email address of the user in Autodesk Fusion == > "This email address will be used for API communication. This user must have adequate perrmissions in Fusion Manage to perform required API functions" + Autodesk Forge app registration: + - ClientID : Unique Autodesk Forge Client ID ==> which was generated inside on of the steps above. + - ClietnSecret: Unique Autodesk Forge API secret + +## Getting Started + +## Known Issues and Limitations +All Fusion Manage BOM funcios are not included in actual version + +## Frequently Asked Questions + +### How to structure Body content for create Item in Fusion Manage +Post - Item Create: gains you the ability to create a new item inside of chosen workspace. + +CUSTOM_LOOKUP_NAME - picklist custom ID +INTEGER - array number of desired element inside of the picklist +WSID - Workspace ID +example: +{ + "sections": [ + { + "link": "/api/v3/workspaces/WSID/sections/SECTION_ID", + "fields": [ + { + "__self__": "/api/v3/workspaces/WSID/views/1/fields/FIELD_CUSTOM_ID", + "value": "string" + }, + { + "__self__": "/api/v3/workspaces/WSID/views/1/fields/FIELD_CUSTOM_ID", + "value": "string" + }, + { + "__self__": "/api/v3/workspaces/WSID/views/1/fields/FIELD_CUSTOM_ID", + "value": { + "link": "/api/v3/lookups/CUSTOM_LOOKUP_NAME/options/INTEGER" + } + } + ] + }, + { + "link": "/api/v3/workspaces/WSID/sections/SECTION_ID", + "fields": [ + { + "__self__": "/api/v3/workspaces/WSID/views/1/fields/FIELD_CUSTOM_ID", + "value": { + "link": "/api/v3/workspaces/WSID/items/DMSID" + } + }, + { + "__self__": "/api/v3/workspaces/WSID/views/1/fields/FIELD_CUSTOM_ID", + "value": "string" + } + ] + } + ] +}