DocdokuPLM API
DocDokuPLM REST API
Version: 2.5.0
AGPL-3.0
GNU Affero General Public License v3.0
Access
[ Jump to Models ]
Table of Contents
post /accounts/createput /accounts/gcmdelete /accounts/gcmget /accounts/meput /accounts/meget /accounts/workspacesget /admin/accountsput /admin/accountsput /admin/accounts/{login}/enableget /admin/disk-usage-statsget /admin/documents-statsput /admin/index-allput /admin/index/{workspaceId}get /admin/parts-statsget /admin/platform-optionsput /admin/platform-optionsget /admin/products-statsget /admin/providerspost /admin/providersget /admin/providers/{id}put /admin/providers/{id}delete /admin/providers/{id}get /admin/users-statsput /admin/workspace/{workspaceId}/enablepost /auth/loginget /auth/logoutpost /auth/oauthget /auth/providersget /auth/providers/{id}post /auth/recoverpost /auth/recoverypost /files/{workspaceId}/document-templates/{templateId}get /files/{workspaceId}/document-templates/{templateId}/{fileName}post /files/{workspaceId}/documents/{documentId}/{version}/{iteration}get /files/{workspaceId}/documents/{documentId}/{version}/{iteration}/{fileName}post /files/{workspaceId}/part-templates/{templateId}get /files/{workspaceId}/part-templates/{templateId}/{fileName}post /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/attachedfilespost /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/nativecadget /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{fileName}get /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{subType}/{fileName}post /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration}get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration}/{fileName}post /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration}get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration}/{fileName}get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/{fileName}get /languagesget /organizationsput /organizationspost /organizationsdelete /organizationsput /organizations/add-memberget /organizations/membersput /organizations/move-memberput /organizations/remove-memberget /platform/healthget /shared/{uuid}/documentsget /shared/{uuid}/partsget /shared/{workspaceId}/documents/{documentId}-{documentVersion}get /shared/{workspaceId}/parts/{partNumber}-{partVersion}get /timezonesget /workspacespost /workspacesget /workspaces/moreget /workspaces/reachable-usersput /workspaces/{workspaceId}delete /workspaces/{workspaceId}put /workspaces/{workspaceId}/add-userput /workspaces/{workspaceId}/adminget /workspaces/{workspaceId}/back-optionsput /workspaces/{workspaceId}/back-optionsget /workspaces/{workspaceId}/changes/issuespost /workspaces/{workspaceId}/changes/issuesget /workspaces/{workspaceId}/changes/issues/linkget /workspaces/{workspaceId}/changes/issues/{issueId}put /workspaces/{workspaceId}/changes/issues/{issueId}delete /workspaces/{workspaceId}/changes/issues/{issueId}put /workspaces/{workspaceId}/changes/issues/{issueId}/aclput /workspaces/{workspaceId}/changes/issues/{issueId}/affected-documentsput /workspaces/{workspaceId}/changes/issues/{issueId}/affected-partsput /workspaces/{workspaceId}/changes/issues/{issueId}/tagspost /workspaces/{workspaceId}/changes/issues/{issueId}/tagsdelete /workspaces/{workspaceId}/changes/issues/{issueId}/tags/{tagName}get /workspaces/{workspaceId}/changes/milestonespost /workspaces/{workspaceId}/changes/milestonesget /workspaces/{workspaceId}/changes/milestones/{milestoneId}put /workspaces/{workspaceId}/changes/milestones/{milestoneId}delete /workspaces/{workspaceId}/changes/milestones/{milestoneId}put /workspaces/{workspaceId}/changes/milestones/{milestoneId}/aclget /workspaces/{workspaceId}/changes/milestones/{milestoneId}/ordersget /workspaces/{workspaceId}/changes/milestones/{milestoneId}/requestsget /workspaces/{workspaceId}/changes/orderspost /workspaces/{workspaceId}/changes/ordersget /workspaces/{workspaceId}/changes/orders/{orderId}put /workspaces/{workspaceId}/changes/orders/{orderId}delete /workspaces/{workspaceId}/changes/orders/{orderId}put /workspaces/{workspaceId}/changes/orders/{orderId}/aclput /workspaces/{workspaceId}/changes/orders/{orderId}/affected-documentsput /workspaces/{workspaceId}/changes/orders/{orderId}/affected-partsput /workspaces/{workspaceId}/changes/orders/{orderId}/affected-requestsput /workspaces/{workspaceId}/changes/orders/{orderId}/tagspost /workspaces/{workspaceId}/changes/orders/{orderId}/tagsdelete /workspaces/{workspaceId}/changes/orders/{orderId}/tags/{tagName}get /workspaces/{workspaceId}/changes/requestspost /workspaces/{workspaceId}/changes/requestsget /workspaces/{workspaceId}/changes/requests/linkget /workspaces/{workspaceId}/changes/requests/{requestId}put /workspaces/{workspaceId}/changes/requests/{requestId}delete /workspaces/{workspaceId}/changes/requests/{requestId}put /workspaces/{workspaceId}/changes/requests/{requestId}/aclput /workspaces/{workspaceId}/changes/requests/{requestId}/affected-documentsput /workspaces/{workspaceId}/changes/requests/{requestId}/affected-issuesput /workspaces/{workspaceId}/changes/requests/{requestId}/affected-partsput /workspaces/{workspaceId}/changes/requests/{requestId}/tagspost /workspaces/{workspaceId}/changes/requests/{requestId}/tagsdelete /workspaces/{workspaceId}/changes/requests/{requestId}/tags/{tagName}get /workspaces/{workspaceId}/checked-out-documents-statsget /workspaces/{workspaceId}/checked-out-parts-statsput /workspaces/{workspaceId}/disable-groupput /workspaces/{workspaceId}/disable-userget /workspaces/{workspaceId}/disk-usage-statsget /workspaces/{workspaceId}/document-baselinespost /workspaces/{workspaceId}/document-baselinesget /workspaces/{workspaceId}/document-baselines/{baselineId}delete /workspaces/{workspaceId}/document-baselines/{baselineId}get /workspaces/{workspaceId}/document-baselines/{baselineId}-lightget /workspaces/{workspaceId}/document-baselines/{baselineId}/export-filesget /workspaces/{workspaceId}/document-templatespost /workspaces/{workspaceId}/document-templatesget /workspaces/{workspaceId}/document-templates/{templateId}put /workspaces/{workspaceId}/document-templates/{templateId}delete /workspaces/{workspaceId}/document-templates/{templateId}put /workspaces/{workspaceId}/document-templates/{templateId}/aclput /workspaces/{workspaceId}/document-templates/{templateId}/files/{fileName}delete /workspaces/{workspaceId}/document-templates/{templateId}/files/{fileName}get /workspaces/{workspaceId}/document-templates/{templateId}/generate_idget /workspaces/{workspaceId}/documentsget /workspaces/{workspaceId}/documents/checkedoutget /workspaces/{workspaceId}/documents/countget /workspaces/{workspaceId}/documents/countCheckedOutget /workspaces/{workspaceId}/documents/doc_revsget /workspaces/{workspaceId}/documents/searchget /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}delete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/aborted-workflowsput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/aclput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkinput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkoutput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName}delete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName}put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/moveput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/newVersionput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/subscribeput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/unsubscribeput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/subscribeput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/unsubscribeput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/obsoleteput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/publishput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/releasepost /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/shareput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tagspost /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tagsdelete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags/{tagName}put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/undocheckoutput /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/unpublishget /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-document-linkget /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-part-linkget /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-path-data-linkget /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-product-instances-linkget /workspaces/{workspaceId}/effectivities/{effectivityId}put /workspaces/{workspaceId}/effectivities/{effectivityId}put /workspaces/{workspaceId}/enable-groupput /workspaces/{workspaceId}/enable-userget /workspaces/{workspaceId}/folderspost /workspaces/{workspaceId}/foldersget /workspaces/{workspaceId}/folders/{completePath}/foldersput /workspaces/{workspaceId}/folders/{folderId}delete /workspaces/{workspaceId}/folders/{folderId}get /workspaces/{workspaceId}/folders/{folderId}/documentspost /workspaces/{workspaceId}/folders/{folderId}/documentsput /workspaces/{workspaceId}/folders/{folderId}/movepost /workspaces/{workspaceId}/folders/{parentFolderPath}/foldersget /workspaces/{workspaceId}/front-optionsput /workspaces/{workspaceId}/front-optionsput /workspaces/{workspaceId}/group-accessget /workspaces/{workspaceId}/groupsget /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptionsput /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName}delete /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName}get /workspaces/{workspaceId}/groups/{groupId}/usersput /workspaces/{workspaceId}/indexget /workspaces/{workspaceId}/lovpost /workspaces/{workspaceId}/lovget /workspaces/{workspaceId}/lov/{name}put /workspaces/{workspaceId}/lov/{name}delete /workspaces/{workspaceId}/lov/{name}get /workspaces/{workspaceId}/memberships/usergroupsget /workspaces/{workspaceId}/memberships/usergroups/meget /workspaces/{workspaceId}/memberships/usersget /workspaces/{workspaceId}/memberships/users/meput /workspaces/{workspaceId}/notifications/{notificationId}get /workspaces/{workspaceId}/part-templatespost /workspaces/{workspaceId}/part-templatesget /workspaces/{workspaceId}/part-templates/{templateId}put /workspaces/{workspaceId}/part-templates/{templateId}delete /workspaces/{workspaceId}/part-templates/{templateId}put /workspaces/{workspaceId}/part-templates/{templateId}/aclput /workspaces/{workspaceId}/part-templates/{templateId}/files/{fileName}delete /workspaces/{workspaceId}/part-templates/{templateId}/files/{fileName}get /workspaces/{workspaceId}/part-templates/{templateId}/generate_idget /workspaces/{workspaceId}/partspost /workspaces/{workspaceId}/partsget /workspaces/{workspaceId}/parts/checkedoutget /workspaces/{workspaceId}/parts/countget /workspaces/{workspaceId}/parts/countCheckedOutpost /workspaces/{workspaceId}/parts/importget /workspaces/{workspaceId}/parts/import/{importId}delete /workspaces/{workspaceId}/parts/import/{importId}post /workspaces/{workspaceId}/parts/importPreviewget /workspaces/{workspaceId}/parts/imports/{filename}get /workspaces/{workspaceId}/parts/numbersget /workspaces/{workspaceId}/parts/parts_last_iterget /workspaces/{workspaceId}/parts/queriespost /workspaces/{workspaceId}/parts/queriesdelete /workspaces/{workspaceId}/parts/queries/{queryId}get /workspaces/{workspaceId}/parts/queries/{queryId}/format/{export}post /workspaces/{workspaceId}/parts/query-exportget /workspaces/{workspaceId}/parts/searchget /workspaces/{workspaceId}/parts/tags/{tagId}get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/aborted-workflowsput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/aclget /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/baselinesput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkinput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkoutget /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivitiespost /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivitiesdelete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivities/{effectivityId}get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/instancesput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversionput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversionput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName}delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName}put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/newVersionput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/obsoleteput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/publishput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/releasepost /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/shareput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tagspost /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tagsdelete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags/{tagName}put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/undocheckoutput /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/unpublishget /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-componentget /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-substituteget /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-product-instance-mastersget /workspaces/{workspaceId}/parts/{partNumber}/filter/{baselineId}get /workspaces/{workspaceId}/parts/{partNumber}/latest-revisionget /workspaces/{workspaceId}/product-baselinespost /workspaces/{workspaceId}/product-baselinesget /workspaces/{workspaceId}/product-baselines/{ciId}/baselinesget /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}delete /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/partsget /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links-typesget /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links/source/{sourcePath}/target/{targetPath}get /workspaces/{workspaceId}/product-configurationspost /workspaces/{workspaceId}/product-configurationsget /workspaces/{workspaceId}/product-configurations/{ciId}/configurationsget /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}delete /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}put /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}/aclget /workspaces/{workspaceId}/product-instancespost /workspaces/{workspaceId}/product-instancespost /workspaces/{workspaceId}/product-instances/importget /workspaces/{workspaceId}/product-instances/{ciId}/instancesget /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/aclget /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterationsget /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}/files/{fileName}delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}/files/{fileName}get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/link-path-part/{pathPart}get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-linksget /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links-roots/{type}get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links-typesget /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links/source/{sourcePath}/target/{targetPath}get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links/{pathToPathLinkId}post /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}/files/{fileName}delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}/files/{fileName}get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{path}post /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{path}/newput /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/rebaseget /workspaces/{workspaceId}/productspost /workspaces/{workspaceId}/productsget /workspaces/{workspaceId}/products/numbersget /workspaces/{workspaceId}/products/{ciId}delete /workspaces/{workspaceId}/products/{ciId}get /workspaces/{workspaceId}/products/{ciId}/bomput /workspaces/{workspaceId}/products/{ciId}/cascade-checkinput /workspaces/{workspaceId}/products/{ciId}/cascade-checkoutput /workspaces/{workspaceId}/products/{ciId}/cascade-undocheckoutget /workspaces/{workspaceId}/products/{ciId}/decode-path/{path}get /workspaces/{workspaceId}/products/{ciId}/document-links/{partNumber}-{partVersion}-{partIteration}/{configSpec}get /workspaces/{workspaceId}/products/{ciId}/export-filesget /workspaces/{workspaceId}/products/{ciId}/filterget /workspaces/{workspaceId}/products/{ciId}/instancespost /workspaces/{workspaceId}/products/{ciId}/instancesget /workspaces/{workspaceId}/products/{ciId}/layerspost /workspaces/{workspaceId}/products/{ciId}/layersput /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}delete /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}get /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markerspost /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markersdelete /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers/{markerId}get /workspaces/{workspaceId}/products/{ciId}/path-choicespost /workspaces/{workspaceId}/products/{ciId}/path-to-path-linksget /workspaces/{workspaceId}/products/{ciId}/path-to-path-links-typesget /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/source/{sourcePath}/target/{targetPath}put /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/{pathToPathLinkId}delete /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/{pathToPathLinkId}get /workspaces/{workspaceId}/products/{ciId}/pathsget /workspaces/{workspaceId}/products/{ciId}/releases/lastget /workspaces/{workspaceId}/products/{ciId}/versions-choicesput /workspaces/{workspaceId}/remove-from-group/{groupId}put /workspaces/{workspaceId}/remove-from-workspaceget /workspaces/{workspaceId}/rolespost /workspaces/{workspaceId}/rolesget /workspaces/{workspaceId}/roles/inuseput /workspaces/{workspaceId}/roles/{roleName}delete /workspaces/{workspaceId}/roles/{roleName}get /workspaces/{workspaceId}/stats-overviewget /workspaces/{workspaceId}/tagspost /workspaces/{workspaceId}/tagspost /workspaces/{workspaceId}/tags/multipledelete /workspaces/{workspaceId}/tags/{tagId}get /workspaces/{workspaceId}/tags/{tagId}/documentspost /workspaces/{workspaceId}/tags/{tagId}/documentsget /workspaces/{workspaceId}/tasks/{assignedUserLogin}/assignedget /workspaces/{workspaceId}/tasks/{assignedUserLogin}/documentsget /workspaces/{workspaceId}/tasks/{assignedUserLogin}/partsget /workspaces/{workspaceId}/tasks/{taskId}put /workspaces/{workspaceId}/tasks/{taskId}/processput /workspaces/{workspaceId}/user-accessget /workspaces/{workspaceId}/user-grouppost /workspaces/{workspaceId}/user-groupdelete /workspaces/{workspaceId}/user-group/{groupId}get /workspaces/{workspaceId}/usersget /workspaces/{workspaceId}/users-statsget /workspaces/{workspaceId}/users/adminget /workspaces/{workspaceId}/users/meget /workspaces/{workspaceId}/users/{login}/tag-subscriptionsput /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName}delete /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName}get /workspaces/{workspaceId}/webhookspost /workspaces/{workspaceId}/webhooksget /workspaces/{workspaceId}/webhooks/{webhookId}put /workspaces/{workspaceId}/webhooks/{webhookId}delete /workspaces/{workspaceId}/webhooks/{webhookId}get /workspaces/{workspaceId}/workflow-instances/{workflowId}get /workspaces/{workspaceId}/workflow-instances/{workflowId}/abortedget /workspaces/{workspaceId}/workflow-modelspost /workspaces/{workspaceId}/workflow-modelsget /workspaces/{workspaceId}/workflow-models/{workflowModelId}put /workspaces/{workspaceId}/workflow-models/{workflowModelId}delete /workspaces/{workspaceId}/workflow-models/{workflowModelId}put /workspaces/{workspaceId}/workflow-models/{workflowModelId}/aclget /workspaces/{workspaceId}/workspace-workflowspost /workspaces/{workspaceId}/workspace-workflowsget /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId}delete /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId}
Create user's account (createAccount)
Request body
body (required)
Body Parameter — Account to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created AccountDTO. Response will contain authentication token.
202
Account creation successful, but not yet enabled
400
Bad request, read response message for more details
500
Internal server error
Update GCM account for authenticated user (setGCMAccount)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — GCM account to set
Responses
204
Successful retrieval of created GCMAccount.
401
Unauthorized
500
Internal server error
Update GCM account for authenticated user (deleteGCMAccount)
Responses
204
Successful delete of GCMAccount
401
Unauthorized
500
Internal server error
Get authenticated user's account (getAccount)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of AccountDTO
401
Unauthorized
500
Internal server error
Update user's account (updateAccount)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Updated account
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated AccountDTO
401
Unauthorized
500
Internal server error
Up
get /accounts/workspaces
Get workspaces where authenticated user is active (getWorkspaces)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of Workspaces. It can be an empty list.
401
Unauthorized
500
Internal server error
Get accounts (getAccounts)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of Accounts
401
Unauthorized
500
Internal server error
Update account (updateAccount_1)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Updated account
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated Account
401
Unauthorized
500
Internal server error
Up
put /admin/accounts/{login}/enable
Enable or disable account (enableAccount)
Path parameters
login (required)
Path Parameter — Workspace id
Query parameters
enabled (required)
Query Parameter — Enabled
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated Account
401
Unauthorized
500
Internal server error
Up
get /admin/disk-usage-stats
Get disk usage stats (getDiskSpaceUsageStats)
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of disk usage statistics
401
Unauthorized
500
Internal server error
Up
get /admin/documents-stats
Get documents stats (getDocumentsStats)
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of documents statistics
401
Unauthorized
500
Internal server error
Synchronize index for all workspaces (indexAllWorkspaces)
Responses
202
Accepted delete operation (asynchronous method)
401
Unauthorized
500
Internal server error
Up
put /admin/index/{workspaceId}
Synchronize index for workspace (indexWorkspaceData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Responses
202
Accepted delete operation (asynchronous method)
401
Unauthorized
500
Internal server error
Up
get /admin/parts-stats
Get parts stats (getPartsStats)
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of parts statistics
401
Unauthorized
500
Internal server error
Up
get /admin/platform-options
Get platform options (getPlatformOptions)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PlatformOptions
401
Unauthorized
500
Internal server error
Up
put /admin/platform-options
Set platform options (setPlatformOptions)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — Options to set
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful update of PlatformOptions
401
Unauthorized
500
Internal server error
Up
get /admin/products-stats
Get products stats (getProductsStats)
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of products statistics
401
Unauthorized
500
Internal server error
Get detailed providers (getDetailedProviders)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of auth providers
401
Unauthorized
500
Internal server error
Create provider (createProvider)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Updated account
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful creation of auth provider
401
Unauthorized
500
Internal server error
Up
get /admin/providers/{id}
Get detailed provider (getDetailedProvider)
Path parameters
id (required)
Path Parameter — Provider id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of auth provider
401
Unauthorized
500
Internal server error
Up
put /admin/providers/{id}
Update provider (updateProvider)
Path parameters
id (required)
Path Parameter — OAuthProvider id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Updated provider
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful update of auth provider
401
Unauthorized
500
Internal server error
Up
delete /admin/providers/{id}
Remove provider (removeProvider)
Path parameters
id (required)
Path Parameter — OAuthProvider id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful removal of auth provider
401
Unauthorized
500
Internal server error
Up
get /admin/users-stats
Get users stats (getUsersStats)
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of user statistics
401
Unauthorized
500
Internal server error
Up
put /admin/workspace/{workspaceId}/enable
Enable or disable workspace (enableWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
enabled (required)
Query Parameter — Enabled
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated Workspace
401
Unauthorized
500
Internal server error
Try to authenticate (login)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Login request
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful login
403
Unsuccessful login
500
Internal server error
Log out connected user (logout)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful logout
500
Internal server error
Try to authenticate with oauth (oAuthLogin)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — OAuth login request
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful login
403
Unsuccessful login
500
Internal server error
Get supported providers (getProviders)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of providers. It can be an empty list.
500
Internal server error
Up
get /auth/providers/{id}
Get provider details (getProvider)
Path parameters
id (required)
Path Parameter — Password recovery process
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of provider.
404
Provider not found
500
Internal server error
Recover password (sendPasswordRecover)
Request body
body (required)
Body Parameter — Password recovery process
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful recover request
500
Internal server error
Send password recovery request (sendPasswordRecovery)
Request body
body (required)
Body Parameter — Password recovery request
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful request
500
Internal server error
Up
post /files/{workspaceId}/document-templates/{templateId}
Upload document template file (uploadDocumentTemplateFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/document-templates/{templateId}/{fileName}
Download document template file (downloadDocumentTemplateFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/documents/{documentId}/{version}/{iteration}
Upload document file (uploadDocumentFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
version (required)
Path Parameter — Workspace version
iteration (required)
Path Parameter — Document iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/documents/{documentId}/{version}/{iteration}/{fileName}
Download document file (downloadDocumentFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
version (required)
Path Parameter — Workspace version
iteration (required)
Path Parameter — Document iteration
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
uuid (optional)
Query Parameter — Shared entity uuid
token (optional)
Query Parameter — Shared entity token
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/part-templates/{templateId}
Upload part template files (uploadPartTemplateFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/part-templates/{templateId}/{fileName}
Download part template file (downloadPartTemplateFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/attachedfiles
Upload attached file (uploadAttachedFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
version (required)
Path Parameter — Part version
iteration (required)
Path Parameter — Part iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/nativecad
Upload CAD file (uploadNativeCADFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
version (required)
Path Parameter — Part version
iteration (required)
Path Parameter — Part iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
200
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{fileName}
Download part file (downloadDirectPartFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
version (required)
Path Parameter — Part version
iteration (required)
Path Parameter — Part iteration
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
uuid (optional)
Query Parameter — Shared entity uuid
token (optional)
Query Parameter — Shared entity token
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/parts/{partNumber}/{version}/{iteration}/{subType}/{fileName}
Download part file (downloadPartFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
version (required)
Path Parameter — Part version
iteration (required)
Path Parameter — Part iteration
subType (required)
Path Parameter — File sub type
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
uuid (optional)
Query Parameter — Shared entity uuid
token (optional)
Query Parameter — Shared entity token
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration}
Upload product instance files (uploadFilesToProductInstanceIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/iterations/{iteration}/{fileName}
Download product instance file (downloadFileFromProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
post /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration}
Upload path data iteration file (uploadFilesToPathDataIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
pathDataId (required)
Path Parameter — PathDataMaster Id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
upload (required)
Form Parameter —
Responses
204
Upload success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/iterations/{iteration}/{fileName}
Download path data iteration file (downloadFileFromPathDataIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
serialNumber (required)
Path Parameter — Serial number
ciId (required)
Path Parameter — Configuration item id
pathDataId (required)
Path Parameter — Path data master id
iteration (required)
Path Parameter — Path data iteration number
fileName (required)
Path Parameter — File name id
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Up
get /files/{workspaceId}/product-instances/{serialNumber}/{ciId}/pathdata/{pathDataId}/{fileName}
Download path data file (downloadFileFromPathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
serialNumber (required)
Path Parameter — Serial number
ciId (required)
Path Parameter — Configuration item id
pathDataId (required)
Path Parameter — Path data master id
fileName (required)
Path Parameter — File name
Query parameters
type (optional)
Query Parameter — Type
output (optional)
Query Parameter — Output
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Download success
401
Unauthorized
500
Internal server error
Get languages (getLanguages)
Return type
array[String]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of supported languages
500
Internal server error
Get organization for authenticated user (getOrganization)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of OrganizationDTO. It may be a null object
401
Unauthorized
500
Internal server error
Update authenticated user's organization (updateOrganization)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Updated organization
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated OrganizationDTO
401
Unauthorized
500
Internal server error
Create authenticated user's organization (createOrganization)
Request body
body (required)
Body Parameter — Organization to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created OrganizationDTO
401
Unauthorized
500
Internal server error
Delete authenticated user's organization (deleteOrganization)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of OrganizationDTO
401
Unauthorized
500
Internal server error
Up
put /organizations/add-member
Add a member to the authenticated user's organization (addMember)
Request body
body (required)
Body Parameter — User to add
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful member add operation
401
Unauthorized
500
Internal server error
Up
get /organizations/members
Get members of the authenticated user's organization (getMembers)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of AccountDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /organizations/move-member
Move a member up or down in the authenticated user's organization (moveMember)
Request body
body (required)
Body Parameter — User to move up
Query parameters
direction (required)
Query Parameter — Direction (up/down)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful member moved operation
401
Unauthorized
500
Internal server error
Up
put /organizations/remove-member
Remove a member to the authenticated user's organization (removeMember)
Request body
body (required)
Body Parameter — User to remove
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful member removal operation
401
Unauthorized
500
Internal server error
Get platform health status (getPlatformHealthStatus)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Server health is ok
500
Server health is ko or partial
Up
get /shared/{uuid}/documents
Get shared document (getDocumentWithSharedEntity)
Path parameters
uuid (required)
Path Parameter — Resource token
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /shared/{uuid}/parts
Get shared part (getPartWithSharedEntity)
Path parameters
uuid (required)
Path Parameter — Resource token
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /shared/{workspaceId}/documents/{documentId}-{documentVersion}
Get document revision (getPublicSharedDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /shared/{workspaceId}/parts/{partNumber}-{partVersion}
Get part revision (getPublicSharedPartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Get timezones (getTimeZones)
Return type
array[String]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of timezones. It can be an empty list.
401
Unauthorized
500
Internal server error
Get workspace list for authenticated user (getWorkspacesForConnectedUser)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceListDTO
401
Unauthorized
500
Internal server error
Create workspace (createWorkspace)
Request body
body (required)
Body Parameter — Workspace to create
Query parameters
userLogin (optional)
Query Parameter — Login for workspace admin
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created Workspace
401
Unauthorized
500
Internal server error
Get detailed workspace list for authenticated user (getDetailedWorkspacesForConnectedUser)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceDetailsDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/reachable-users
Get online users visible by current user (getReachableUsersForCaller)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}
Update workspace (updateWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Workspace values to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated WorkspaceDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}
Delete workspace (deleteWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Accepted deletion (asynchronous method)
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/add-user
Add user to workspace (addUser)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — User to add
Query parameters
group (optional)
Query Parameter — Group id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful addition of user in UserGroupDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/admin
Set a new admin (setNewAdmin)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — New admin user
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated Workspace
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/back-options
Get workspace back options (getWorkspaceBackOptions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of workspace back options
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/back-options
Update workspace back options (updateWorkspaceBackOptions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Option values
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful update of workspace back options
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/issues
Get issues for given parameters (getIssues)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeIssueDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/issues
Create issue (createIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change issue to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/issues/link
Search issue with given reference (searchIssuesToLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeIssueDTOs. It can be an empty list
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/issues/{issueId}
Get one issue (getIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/issues/{issueId}
Update issue (updateIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change issue to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/issues/{issueId}
Delete issue (removeIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Responses
200
successful operation
204
Successful deletion
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/issues/{issueId}/acl
Update ACL of an issue (updateChangeIssueACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Return type
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/issues/{issueId}/affected-documents
Attach a document to an issue (saveChangeIssueAffectedDocuments)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document list to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/issues/{issueId}/affected-parts
Attach a part to an issue (saveChangeIssueAffectedParts)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Part list to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/issues/{issueId}/tags
Update tags attached to an issue (saveChangeItemTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/issues/{issueId}/tags
Attached a new tag to an issue (addTagToChangeIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/issues/{issueId}/tags/{tagName}
Delete a tag attached to an issue (removeTagsFromChangeIssue)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
issueId (required)
Path Parameter — Issue id
tagName (required)
Path Parameter — Tag name
Return type
Responses
200
successful operation
204
Successful retrieval of updated ChangeIssueDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/milestones
Get milestones for given parameters (getMilestones)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of MilestoneDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/milestones
Create milestone (createMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Milestone to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created MilestoneDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/milestones/{milestoneId}
Get milestone (getMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of MilestoneDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/milestones/{milestoneId}
Update milestone (updateMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Milestone to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated MilestoneDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/milestones/{milestoneId}
Delete milestone (removeMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of MilestoneDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/milestones/{milestoneId}/acl
Update ACL of the milestone (updateMilestoneACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful ACL update of MilestoneDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/milestones/{milestoneId}/orders
Get orders for the given milestone (getOrdersByMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ChangeOrderDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/milestones/{milestoneId}/requests
Get requests for the given milestone (getRequestsByMilestone)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
milestoneId (required)
Path Parameter — Milestone id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ChangeRequestDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/orders
Get orders for given parameters (getOrders)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeOrderDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/orders
Create order (createOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change order to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/orders/{orderId}
Get order (getOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}
Update order (updateOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change order to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/orders/{orderId}
Delete order (removeOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}/acl
Update ACL of the order (updateChangeOrderACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Return type
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}/affected-documents
Attach document to order (saveChangeOrderAffectedDocuments)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Documents to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}/affected-parts
Attach part to order (saveChangeOrderAffectedParts)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Parts to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}/affected-requests
Attach request to order (saveAffectedRequests)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change requests to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/orders/{orderId}/tags
Update tag attached to order (saveChangeOrderTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/orders/{orderId}/tags
Add new tag to order (addTagToChangeOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/orders/{orderId}/tags/{tagName}
Delete tag attached to order (removeTagsFromChangeOrder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
orderId (required)
Path Parameter — Order id
tagName (required)
Path Parameter — Tag name
Return type
Responses
200
Successful retrieval of updated ChangeOrderDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/requests
Get requests for given parameters (getRequests)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeRequestDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/requests
Create request (createRequest)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change request to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/requests/link
Search request for given references (searchRequestsToLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeRequestDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/changes/requests/{requestId}
Get request (getRequest)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}
Update request (updateRequest)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Request to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/requests/{requestId}
Delete request (removeRequest)
Path parameters
workspaceId (required)
Path Parameter —
requestId (required)
Path Parameter —
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Responses
200
successful operation
204
Successful deletion of ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}/acl
Update ACL of a request (updateChangeRequestACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Return type
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}/affected-documents
Attach document to a request (saveChangeRequestAffectedDocuments)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document list to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}/affected-issues
Attach issue to a request (saveAffectedIssues)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Change issues to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}/affected-parts
Attach part to a request (saveChangeRequestAffectedParts)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Parts to save as affected
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/changes/requests/{requestId}/tags
Update tag attached to a request (saveChangeRequestTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/changes/requests/{requestId}/tags
Attach a new tag to a request (addTagsToChangeRequest)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/changes/requests/{requestId}/tags/{tagName}
Delete tag attached to a request (removeTagFromChangeRequest)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
requestId (required)
Path Parameter — Request id
tagName (required)
Path Parameter — Tag to remove
Return type
Responses
200
Successful retrieval of updated ChangeRequestDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/checked-out-documents-stats
Get checked out documents stats for workspace (getCheckedOutDocumentsStats)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of documents stats
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/checked-out-parts-stats
Get checked out parts stats for workspace (getCheckedOutPartsStats)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of parts stats
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/disable-group
Disable group (disableGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Group to disable
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful disable operation
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/disable-user
Disable user (disableUser)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — User to disable
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful disable operation
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/disk-usage-stats
Get disk usage stats for workspace (getDiskSpaceUsageStats_2)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DiskUsageSpaceDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-baselines
Get baselines (getDocumentBaselines)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked out DocumentBaselineDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/document-baselines
Create baseline (createDocumentBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document baseline to create
Return type
Responses
200
successful operation
201
Successful retrieval of created DocumentBaselineDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-baselines/{baselineId}
Get baseline (getBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
baselineId (required)
Path Parameter — Baseline id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentBaselineDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/document-baselines/{baselineId}
Delete a baseline (deleteBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
baselineId (required)
Path Parameter — Baseline id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of DocumentBaselineDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-baselines/{baselineId}-light
Get document baseline in a light format (getBaselineLight)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
baselineId (required)
Path Parameter — Baseline id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentBaselineDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-baselines/{baselineId}/export-files
Export files (exportDocumentFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
baselineId (required)
Path Parameter — Baseline id
Return type
Responses
200
Successful files export, download a zipped file containing requested files.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-templates
Get document templates (getDocumentMasterTemplates)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentMasterTemplateDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/document-templates
Create document template (createDocumentMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document master template to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created DocumentMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-templates/{templateId}
Get document template (getDocumentMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/document-templates/{templateId}
Update document template (updateDocumentMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document master template to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated DocumentMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/document-templates/{templateId}
Delete document template (deleteDocumentMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Responses
204
Successful deletion of DocumentMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/document-templates/{templateId}/acl
Update document template ACL (updateDocumentMasterTemplateACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful ACL update
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/document-templates/{templateId}/files/{fileName}
Rename attached file in document template (renameAttachedFileInDocumentTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — File to rename
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful rename file operation
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/document-templates/{templateId}/files/{fileName}
Remove attached file from document template (removeAttachedFileFromDocumentTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of file in DocumentMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/document-templates/{templateId}/generate_id
Generate document template id (generateDocumentMasterId)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TemplateGeneratedIdDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents
Get documents in workspace (getDocumentsInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
start (optional)
Query Parameter — Start offset default: 0
max (optional)
Query Parameter — Max results default: 20
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/checkedout
Get checked out documents (getCheckedOutDocuments)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked out documents. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/count
Count documents (getDocumentsInWorkspaceCount)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of documents count
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/countCheckedOut
Count checked out documents (countCheckedOutDocs)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked out documents count
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/doc_revs
Search documents by id and/or name (searchDocumentRevisionsToLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
l (optional)
Query Parameter — Max results default: 20
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of searched documents. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/search
Search documents (searchDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (optional)
Query Parameter — Query
id (optional)
Query Parameter — Document id
title (optional)
Query Parameter — Document title
type (optional)
Query Parameter — Document type
version (optional)
Query Parameter — Document version
author (optional)
Query Parameter — Document author
tags (optional)
Query Parameter — Document tags
content (optional)
Query Parameter — Document files content
createdFrom (optional)
Query Parameter — Document created from date
createdTo (optional)
Query Parameter — Document creation to date
modifiedFrom (optional)
Query Parameter — Document modified from date
modifiedTo (optional)
Query Parameter — Document modified to date
attributes (optional)
Query Parameter — Document attributes
folder (optional)
Query Parameter — Folder
from (optional)
Query Parameter — Start offset default: 0
size (optional)
Query Parameter — Max results default: 10
fetchHeadOnly (optional)
Query Parameter — Search mode (false for history/ true for head only)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of searched DocumentRevisionDTO. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}
Get document (getDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}
Delete the document (deleteDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Responses
204
Successful deletion of DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/aborted-workflows
Get document's aborted workflow history (getAbortedWorkflowListInDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of aborted WorkflowDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/acl
Update document's ACL (updateDocumentRevisionACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful ACL removal
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkin
Checkin document (checkInDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked in DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/checkout
Checkout document (checkOutDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked out DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}
Update document iteration (updateDocumentIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
docIteration (required)
Path Parameter — Document iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document iteration to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated DocumentIterationDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName}
Rename attached files of document (renameAttachedFileInDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
docIteration (required)
Path Parameter — Document iteration
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — File to rename
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated FileDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/iterations/{docIteration}/files/{fileName}
Remove attached file from document (removeAttachedFileFromDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
docIteration (required)
Path Parameter — Document iteration
fileName (required)
Path Parameter — File name
Responses
204
Successful deletion of file
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/move
Move document to folder (moveDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document revision to move
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/newVersion
Create a new version of the document (createNewDocumentVersion)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — New version of document to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created DocumentRevisionDTO version, and its previous version
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/subscribe
Subscribe to notifications on change events (subscribeToIterationChangeEvent)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Responses
204
Successful change event subscription
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/iterationChange/unsubscribe
Unsubscribe from notifications on change events (unSubscribeToIterationChangeEvent)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Responses
204
Successful change event un-subscription
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/subscribe
Subscribe to notifications on state events (subscribeToStateChangeEvent)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Responses
204
Successful state event subscription
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/notification/stateChange/unsubscribe
Unsubscribe to notifications on state events (unsubscribeToStateChangeEvent)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Responses
204
Successful state event un-subscription
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/obsolete
Set document as obsolete (markDocumentRevisionAsObsolete)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of obsolete DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/publish
Publish a document (publishDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful publication
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/release
Release document (releaseDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of released DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/share
Create a shared document (createSharedDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Shared document to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created SharedDocumentDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags
Set the tags of the document (saveDocTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to save
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags
Add tags to document (addDocTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/tags/{tagName}
Remove tags from document (removeDocTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
tagName (required)
Path Parameter — Tag name
Return type
Responses
200
Successful retrieval of updated DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/undocheckout
Undo checkout document (undoCheckOutDocument)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of undo checked out DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/unpublish
Un-publish a document (unPublishDocumentRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful un-publication
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-document-link
Get inverse documents links (getInverseDocumentLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
iteration (required)
Path Parameter — Document iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTO pointing to this document. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-part-link
Get inverse parts links (getInversePartsLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
iteration (required)
Path Parameter — Document iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO pointing to this document. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-path-data-link
Get inverse path data links (getInversePathDataLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
iteration (required)
Path Parameter — Document iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PathDataMasterDTO pointing to this document. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/documents/{documentId}-{documentVersion}/{iteration}/inverse-product-instances-link
Get inverse product instances links (getInverseProductInstancesLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
documentId (required)
Path Parameter — Document master id
documentVersion (required)
Path Parameter — Document version
iteration (required)
Path Parameter — Document iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTO pointing to this document. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/effectivities/{effectivityId}
Get an effectivity from its ID (getEffectivity)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
effectivityId (required)
Path Parameter — Effectivity id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of effectivity
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/effectivities/{effectivityId}
Update effectivity (updateEffectivity)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
effectivityId (required)
Path Parameter — Effectivity id
Request body
body (required)
Body Parameter — Effectivity values to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated effectivity
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/enable-group
Enable group (enableGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Group to enable
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful enable operation
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/enable-user
Enable user (enableUser)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — User to enable
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful enable operation
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/folders
Get root folders (getRootFolders)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of FolderDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/folders
Create root folder (createRootFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Folder to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created FolderDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/folders/{completePath}/folders
Get sub folders (getSubFolders)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
completePath (required)
Path Parameter — Folder id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of FolderDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/folders/{folderId}
Rename a folder (renameFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
folderId (required)
Path Parameter — Folder id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Folder with new name
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated FolderDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/folders/{folderId}
Delete root folder (deleteRootFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
folderId (required)
Path Parameter — Folder id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of FolderDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/folders/{folderId}/documents
Get documents in folder (getDocumentsWithGivenFolderIdAndWorkspaceId)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
folderId (required)
Path Parameter — Folder id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/folders/{folderId}/documents
Create document (createDocumentMasterInFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
folderId (required)
Path Parameter — Folder id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of created DocumentRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/folders/{folderId}/move
Move a folder (moveFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
folderId (required)
Path Parameter — Folder id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Folder to move
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated FolderDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/folders/{parentFolderPath}/folders
Create a sub folder (createSubFolder)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
parentFolderPath (required)
Path Parameter — Parent folder id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Folder to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created FolderDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/front-options
Get workspace front options (getWorkspaceFrontOptions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieve of workspace front options
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/front-options
Update workspace front options (updateWorkspaceFrontOptions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Option values
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful update of workspace front options
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/group-access
Set group access in workspace (setGroupAccess)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — User to grant access in group
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated WorkspaceUserGroupMemberShipDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/groups
Get groups (getGroups)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserGroupDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions
Get tag subscriptions of group (getTagSubscriptionsForGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TagSubscriptionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName}
Update or create tag subscription of group (updateUserGroupSubscription)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id
tagName (required)
Path Parameter — Tag name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag subscription to update or create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of TagSubscriptionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/groups/{groupId}/tag-subscriptions/{tagName}
Delete tag subscription of group (deleteUserGroupSubscription)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id id
tagName (required)
Path Parameter — Tag name
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of TagSubscriptionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/groups/{groupId}/users
Get users of group (getUsersInGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/index
Index the workspace (synchronizeIndexer)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
202
Accepted indexation (asynchronous method)
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/lov
Get a list of ListOfValues for given parameters (getLOVs)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ListOfValuesDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/lov
Create ListOfValues (createLOV)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — LOV to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of created ListOfValuesDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/lov/{name}
Get the ListOfValues from the given parameters (getLOV)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
name (required)
Path Parameter — Name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of ListOfValuesDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/lov/{name}
Update the ListOfValues (updateLOV)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
name (required)
Path Parameter — Name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — LOV to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of updated ListOfValuesDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/lov/{name}
Delete the ListOfValues (deleteLOV)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
name (required)
Path Parameter — Name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of ListOfValuesDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/memberships/usergroups
Get workspace's group membership for current user (getWorkspaceUserGroupMemberShips)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceUserGroupMemberShipDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/memberships/usergroups/me
Get workspace's group membership for current user (getWorkspaceSpecificUserGroupMemberShips)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceUserGroupMemberShipDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/memberships/users
Get workspace's user memberships (getWorkspaceUserMemberShips)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceUserMemberShipDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/memberships/users/me
Get workspace's user membership for current user (getWorkspaceSpecificUserMemberShips)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceUserMemberShipDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/notifications/{notificationId}
Acknowledge modification notification (acknowledgeNotification)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
notificationId (required)
Path Parameter — Notification id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Modification notification to acknowledge
Responses
204
Successful acknowledge of ModificationNotification
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/part-templates
Get part master templates (getPartMasterTemplates)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartMasterTemplateDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/part-templates
Crate part master template (createPartMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Part master template to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/part-templates/{templateId}
Get part master template (getPartMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/part-templates/{templateId}
Update part master template (updatePartMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Part master template to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/part-templates/{templateId}
Delete part master template (deletePartMasterTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Responses
204
Successful deletion of PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/part-templates/{templateId}/acl
Update part master template ACL (updatePartMasterTemplateACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful update of ACL
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/part-templates/{templateId}/files/{fileName}
Rename attached file in part master template (renameAttachedFileInPartTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — File to rename
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful file renaming of PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/part-templates/{templateId}/files/{fileName}
Remove attached file from part master template (removeAttachedFileFromPartTemplate)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful file deletion of PartMasterTemplateDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/part-templates/{templateId}/generate_id
Generate part master template id (generatePartMasterTemplateId)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
templateId (required)
Path Parameter — Template id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TemplateGeneratedIdDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts
Get part revisions (getPartRevisions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
start (optional)
Query Parameter — Start offset default: 0
length (optional)
Query Parameter — Max results default: 20
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts
Create new part (createNewPart)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Part to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/checkedout
Get checked out part revisions (getCheckedOutPartRevisions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful deletion of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/count
Count part revisions (getTotalNumberOfParts)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO count
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/countCheckedOut
Count checked out part revisions (getCheckedOutNumberOfItems)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO count
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/import
Import part attributes from file (importPartAttributes)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
autoCheckout (optional)
Query Parameter — Auto check out parts flag
autoCheckin (optional)
Query Parameter — Auto check in parts flag
permissiveUpdate (optional)
Query Parameter — Permissive update flag
revisionNote (optional)
Query Parameter — Revision note to add
importType (required)
Query Parameter — Import type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful import
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/import/{importId}
Get import (getImport)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
importId (required)
Path Parameter — Import id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ImportDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/import/{importId}
Delete import (deleteImport)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
importId (required)
Path Parameter — Import id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of ImportDTOs
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/importPreview
Get import preview (getImportPreview)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
autoCheckout (optional)
Query Parameter — Auto check out parts flag
autoCheckin (optional)
Query Parameter — Auto check in parts flag
permissiveUpdate (optional)
Query Parameter — Permissive update flag
importType (required)
Query Parameter — Import type
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ImportPreview.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/imports/{filename}
Get current imports (getImports)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
filename (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ImportDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/numbers
Search part numbers (searchPartNumbers)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPartMasterDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/parts_last_iter
Search documents last iteration to link (searchPartsLastIterationToLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
l (optional)
Query Parameter — Max results default: 15
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartIterationDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/queries
Get custom queries (getCustomQueries)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of QueryDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/queries
Run custom queries (runCustomQuery)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Query to run
Query parameters
save (optional)
Query Parameter — Save the query flag default: false
export (optional)
Query Parameter — Choose export type default: json
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/octet-stream
Responses
200
Successful retrieval of QueryDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/queries/{queryId}
Delete custom query (deleteQuery)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
queryId (required)
Path Parameter — Query id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of QueryDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/queries/{queryId}/format/{export}
Export existing query (exportExistingQuery)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
queryId (required)
Path Parameter — Query id
export (required)
Path Parameter — Choose export type
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful export
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/query-export
Export custom query (exportCustomQuery)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Query to export
Query parameters
export (optional)
Query Parameter — Choose export type default: json
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartIterationDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/search
Search part revisions (searchPartRevisions)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (optional)
Query Parameter — Query
number (optional)
Query Parameter — Part number
name (optional)
Query Parameter — Part name
version (optional)
Query Parameter — Part version
author (optional)
Query Parameter — Part author
type (optional)
Query Parameter — Part type
createdFrom (optional)
Query Parameter — Part created from date
createdTo (optional)
Query Parameter — Part created to date
modifiedFrom (optional)
Query Parameter — Part modified from date
modifiedTo (optional)
Query Parameter — Part modified to date
tags (optional)
Query Parameter — Part tags
content (optional)
Query Parameter — Part files content
attributes (optional)
Query Parameter — Part files attributes
from (optional)
Query Parameter — Start offset default: 0
size (optional)
Query Parameter — Max results default: 10
fetchHeadOnly (optional)
Query Parameter — Search mode (false for history / true for head only)
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/tags/{tagId}
Get part revisions (getPartRevisionsByTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
tagId (required)
Path Parameter — Tag id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}
Get part revision (getPartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}
Delete part (deletePartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/aborted-workflows
Get part's aborted workflow list (getAbortedWorkflowListInPart)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkflowDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/acl
Update part ACL (updatePartRevisionACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful ACL removal of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/baselines
Get baselines where part revision is involved (getBaselinesWherePartRevisionHasIterations)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductBaselineDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkin
Checkin part (checkIn)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked in PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/checkout
Checkout part (checkOut)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of checked out PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivities
Get effectivities of a PartRevision (getEffectivities)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part revision number
partVersion (required)
Path Parameter — Part revision version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of effectivities. It can be an empty list
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivities
Create an Effectivity for a PartRevision (createEffectivity)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part revision number
partVersion (required)
Path Parameter — Part revision version
Request body
body (required)
Body Parameter — Effectivity to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created effectivity
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/effectivities/{effectivityId}
Delete effectivity from part revision (deleteEffectivity)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part revision number
partVersion (required)
Path Parameter — Part revision version
effectivityId (required)
Path Parameter — Effectivity id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of effectivity
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/instances
Get instances under given part, head view (getInstancesUnderPart)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of instance nodes
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}
Update part iteration (updatePartIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Part iteration to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversion
Get conversion status (getConversionStatus)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ConversionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/conversion
Retry conversion (retryConversion)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful conversion retry
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName}
Rename attached file from part iteration (renameAttachedFileInPartIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
subType (required)
Path Parameter — Sub type
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — File to rename
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful renaming of file of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/iterations/{partIteration}/files/{subType}/{fileName}
Remove file from part iteration (removeFile)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
subType (required)
Path Parameter — Sub type
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of file of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/newVersion
Create new part version (createNewPartVersion)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — New version of part to create
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful retrieval of the new version of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/obsolete
Set part as obsolete (markPartRevisionAsObsolete)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of obsolete PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/publish
Publish part revision (publishPartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful publish of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/release
Release part (releasePartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of released PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/share
Create a new shared part (createSharedPart)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Shared part to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created SharedPartDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags
Save part's tags (savePartTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags
Add tags to part (addPartTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to add
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/tags/{tagName}
Delete tags from part (removePartTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
tagName (required)
Path Parameter — Tag name
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/undocheckout
Undo checkout part (undoCheckOut)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of undo checked out PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/unpublish
Un-publish part revision (unPublishPartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful un-publish of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-component
Get part revisions where use as component (getUsedByAsComponent)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-as-substitute
Get part revisions where use as substitute (getUsedByAsSubstitute)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}-{partVersion}/used-by-product-instance-masters
Get product instance where part is in use (getProductInstanceMasters)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}/filter/{baselineId}
Filter part master with config spec (filterPartMasterInBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
baselineId (required)
Path Parameter — Baseline id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartIterationDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/parts/{partNumber}/latest-revision
Get part latest revision (getLatestPartRevision)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
partNumber (required)
Path Parameter — Part number
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines
Get product-baselines with given workspace (getAllProductBaselines)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductBaselineDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-baselines
Create product-baseline (createProductBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Product baseline to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductBaselineDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines
Get product-baseline with given configuration item (getProductBaselinesForProduct)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductBaselineDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}
Get product-baseline (getProductBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
baselineId (required)
Path Parameter — Baseline id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductBaselineDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}
Delete product-baseline (deleteProductBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
baselineId (required)
Path Parameter — Baseline id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of ProductBaselineDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/parts
Get product-baseline's part (getProductBaselineParts)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
baselineId (required)
Path Parameter — Baseline id
Query parameters
q (required)
Query Parameter — Query
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of BaselinedPartDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links-types
Get product-baseline's path-to-path links (getPathToPathLinkTypesInBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
baselineId (required)
Path Parameter — Baseline id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-baselines/{ciId}/baselines/{baselineId}/path-to-path-links/source/{sourcePath}/target/{targetPath}
Get product-baseline's path-to-path links for given source and target (getPathToPathLinkInProductBaseline)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
baselineId (required)
Path Parameter — Baseline id
sourcePath (required)
Path Parameter — Source path
targetPath (required)
Path Parameter — Target path
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-configurations
Get all product configurations in workspace (getAllConfigurations)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductConfigurationDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-configurations
Create product configuration (createConfiguration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Product configuration to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created ProductConfigurationDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-configurations/{ciId}/configurations
Get all product configurations for given product (getConfigurationsForProduct)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id filter
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductConfigurationDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}
Get product configuration (getConfiguration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
productConfigurationId (required)
Path Parameter — Product configuration id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductConfigurationDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}
Delete product configuration (deleteProductConfiguration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
productConfigurationId (required)
Path Parameter — Product configuration id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of ProductConfigurationDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-configurations/{ciId}/configurations/{productConfigurationId}/acl
Update product configuration ACL (updateConfigurationACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
productConfigurationId (required)
Path Parameter — Product configuration id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful ACL update
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances
Get product instances in given workspace (getAllProductInstances)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-instances
Create product-instance (createProductInstanceMaster)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Product instance master to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-instances/import
Import attribute into product-instance (importProductInstanceAttributes)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
autoFreezeAfterUpdate (optional)
Query Parameter — Auto freeze after update flag
permissiveUpdate (optional)
Query Parameter — Permissive update flag
revisionNote (optional)
Query Parameter — Revision note to set
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful import
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances
Get product-instance with given configuration item (getProductInstances)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}
Get product-instance (getProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}
Delete product-instance (deleteProductInstanceMaster)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/acl
Update product-instance's ACL (updateProductInstanceACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL to set
Responses
204
Successful update of ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations
Get product-instance's iterations (getProductInstanceIterations)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceMasterDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}
Get product-instance's iteration (getProductInstanceIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ProductInstanceIterationDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}
Update product-instance (updateProductInstanceMaster)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Product instance master to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}/files/{fileName}
Rename attached file in product instance (renameAttachedFileInProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
iteration (required)
Path Parameter — Product instance iteration
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Renamed file
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of renamed FileDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/iterations/{iteration}/files/{fileName}
Remove attached file from product-instance (removeAttachedFileFromProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
iteration (required)
Path Parameter — Product instance iteration
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Responses
204
Successful deletion of file of ProductInstanceMasterDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/link-path-part/{pathPart}
Get part from path-to-path link (getPartFromPathLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathPart (required)
Path Parameter — Complete path to the part
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links
Get path-to-path links (getPathToPathLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links-roots/{type}
Get root path-to-path links (getRootPathToPathLinks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
type (required)
Path Parameter — Link type
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links-types
Get path-to-path link types (getPathToPathLinkTypesInProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links/source/{sourcePath}/target/{targetPath}
Get path-to-path link for given source and target (getPathToPathLinksForGivenSourceAndTarget)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
sourcePath (required)
Path Parameter — Complete source path
targetPath (required)
Path Parameter — Complete target path
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/path-to-path-links/{pathToPathLinkId}
Get path-to-path link (getPathToPathLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathToPathLinkId (required)
Path Parameter — Path to path link id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}
Add new path-data iteration (addNewPathDataIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathDataId (required)
Path Parameter — Path data master id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Path data iteration to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PathDataMasterDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}
Delete product-instance's path-data (deletePathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathDataId (required)
Path Parameter — Path data master id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of PathDataMaster
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}
Update path-data (updatePathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathDataId (required)
Path Parameter — Path data master id
iteration (required)
Path Parameter — Product instance iteration
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Path data iteration to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated PathDataMaster
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}/files/{fileName}
Rename product-instance's attached file (renameAttachedFileInPathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathDataId (required)
Path Parameter — Path data master id
iteration (required)
Path Parameter — Product instance iteration
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Renamed file
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of renamed FileDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{pathDataId}/iterations/{iteration}/files/{fileName}
Delete product-instance's attached file (deleteAttachedFileInPathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
pathDataId (required)
Path Parameter — Path data master id
iteration (required)
Path Parameter — Product instance iteration
fileName (required)
Path Parameter — File name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful file deletion
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{path}
Get product-instance's path-data (getPathData)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
path (required)
Path Parameter — Complete path in context
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PathDataMasterDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/pathdata/{path}/new
Create new path-data (createPathDataMaster)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
path (required)
Path Parameter — Complete path in context
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Path data iteration create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created PathDataMaster
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/product-instances/{ciId}/instances/{serialNumber}/rebase
Rebase product-instance (rebaseProductInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
serialNumber (required)
Path Parameter — Serial number
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Product baseline to rebase with
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful rebase of ProductInstanceIterationDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products
Get configuration items (getConfigurationItems)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ConfigurationItemDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/products
Create configuration item (createConfigurationItem)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Product to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of ConfigurationItemDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/numbers
Search configuration items (searchConfigurationItemId)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Query parameters
q (required)
Query Parameter — Query
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
Up
get /workspaces/{workspaceId}/products/{ciId}
Get configuration item (getConfigurationItem)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ConfigurationItemDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/products/{ciId}
Delete configuration item (deleteConfigurationItem)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of ConfigurationItemDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/bom
Filter part (filterPart)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpec (optional)
Query Parameter — Config spec
path (optional)
Query Parameter — Complete path of part
diverge (optional)
Query Parameter — Discover substitute links
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/products/{ciId}/cascade-checkin
Cascade check in (cascadeCheckin)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Iteration note to add
Query parameters
configSpec (optional)
Query Parameter — Config spec
path (required)
Query Parameter — Complete path to checkin from
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of CascadeResult
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/products/{ciId}/cascade-checkout
Cascade check out (cascadeCheckout)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpec (optional)
Query Parameter — Config spec
path (required)
Query Parameter — Complete path to checkout from
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of CascadeResult
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/products/{ciId}/cascade-undocheckout
Cascade undo check out (cascadeUndoCheckOut)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpec (optional)
Query Parameter — Config spec
path (required)
Query Parameter — Complete path to undo checkout from
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of CascadeResult
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/decode-path/{path}
Decode string path (decodePath)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
path (required)
Path Parameter — Complete path to decode
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPartLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/document-links/{partNumber}-{partVersion}-{partIteration}/{configSpec}
Get document links for given part operation (getDocumentLinksForGivenPartIteration)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
partNumber (required)
Path Parameter — Part number
partVersion (required)
Path Parameter — Part version
partIteration (required)
Path Parameter — Part iteration
configSpec (required)
Path Parameter — Config spec
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentIterationLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/export-files
Export files (exportProductFiles)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpecType (optional)
Query Parameter — Config spec
exportNativeCADFiles (optional)
Query Parameter — Export native cad files flag
exportDocumentLinks (optional)
Query Parameter — Export linked documents attached files flag
Responses
200
Successful export
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/filter
Filter product structure (filterProductStructure)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpec (optional)
Query Parameter — Config spec
path (optional)
Query Parameter — Complete path of part
depth (optional)
Query Parameter — Depth to stop at
linkType (optional)
Query Parameter — Type link to filter
diverge (optional)
Query Parameter — Discover substitute links
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of ComponentDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/instances
Get instances under given path, and config spec (getFilteredInstances)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
configSpec (required)
Query Parameter — Config spec
path (required)
Query Parameter — Complete path to start from
diverge (optional)
Query Parameter — Discover substitute links
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LeafDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/products/{ciId}/instances
Get instances for multiple paths (getInstancesForMultiplePath)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — List of paths to start from
Query parameters
diverge (optional)
Query Parameter — Discover substitute links
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LeafDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/layers
Get layers (getLayersInProduct)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LayerDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/products/{ciId}/layers
Create layers (createLayer)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Layer to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created LayerDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}
Update layer (updateLayer)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
layerId (required)
Path Parameter — Layer id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Layer to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated LayerDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}
Delete layer (deleteLayer)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
layerId (required)
Path Parameter — Layer id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of LayerDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers
Get markers (getMarkersInLayer)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
layerId (required)
Path Parameter — Layer id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of MarkerDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers
Create marker (createMarker)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
layerId (required)
Path Parameter — Layer id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Marker to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created MarkerDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/products/{ciId}/layers/{layerId}/markers/{markerId}
Delete marker (deleteMarker)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
layerId (required)
Path Parameter — Layer id
markerId (required)
Path Parameter — Marker id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of LayerDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/path-choices
Get baseline creation path choices (getBaselineCreationPathChoices)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
type (optional)
Query Parameter — Baseline type
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PathChoiceDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/products/{ciId}/path-to-path-links
Create path to path link (createPathToPathLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Path to path link to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created LightPathToPathLinkDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/path-to-path-links-types
Get path to path links types (getPathToPathLinkTypesInProduct)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of LightPathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/source/{sourcePath}/target/{targetPath}
Get path to path links from source and target (getPathToPathLinkInProduct)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
sourcePath (required)
Path Parameter — Complete source path
targetPath (required)
Path Parameter — Complete target path
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PathToPathLinkDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/{pathToPathLinkId}
Update path to path link (updatePathToPathLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
pathToPathLinkId (required)
Path Parameter — Path to path link id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Path to path link to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated LightPathToPathLinkDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/products/{ciId}/path-to-path-links/{pathToPathLinkId}
Delete path to path link (deletePathToPathLink)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
pathToPathLinkId (required)
Path Parameter — Path to path link id
Responses
204
Successful deletion of PathToPathLink
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/paths
Search paths (searchPaths)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Query parameters
search (required)
Query Parameter — Search value
configSpec (optional)
Query Parameter — Config spec
diverge (optional)
Query Parameter — Discover substitute links
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PathDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/releases/last
Get last release of part (getLastRelease)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/products/{ciId}/versions-choices
Get baseline creation version choices (getBaselineCreationVersionsChoices)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
ciId (required)
Path Parameter — Configuration item id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of BaselinedPartDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/remove-from-group/{groupId}
Remove user from group (removeUserFromGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id
Request body
body (required)
Body Parameter — User to remove from group
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated UserGroupDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/remove-from-workspace
Remove user from workspace (removeUserFromWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — User to remove from workspace
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated WorkspaceDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/roles
Get roles (getRolesInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of RoleDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/roles
Create role (createRole)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Role to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created RoleDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/roles/inuse
Get roles in use (getRolesInUseInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of RoleDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/roles/{roleName}
Update role (updateRole)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
roleName (required)
Path Parameter — Role name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Role to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated RoleDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/roles/{roleName}
Delete role (deleteRole)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
roleName (required)
Path Parameter — Role name
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of RoleDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/stats-overview
Get stats overview for workspace (getStatsOverview)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of StatsOverviewDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tags
Get tags in workspace (getTagsInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TagDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/tags
Create tag in workspace (createTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TagDTO
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/tags/multiple
Create tags in workspace (createTags)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag list to create
Responses
204
Successful creation of TagDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/tags/{tagId}
Delete tag in workspace (deleteTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
tagId (required)
Path Parameter — Tag id
Responses
204
Successful deletion of TagDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tags/{tagId}/documents
Get documents from given tag id (getDocumentsWithGivenTagIdAndWorkspaceId)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
tagId (required)
Path Parameter — Tag id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/tags/{tagId}/documents
Create document (createDocumentMasterInRootFolderWithTag)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
tagId (required)
Path Parameter — Tag id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Document to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tasks/{assignedUserLogin}/assigned
Get assigned tasks for given user (getAssignedTasksForGivenUser)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
assignedUserLogin (required)
Path Parameter — Assigned user login
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TaskDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tasks/{assignedUserLogin}/documents
Get documents where user has assigned tasks (getDocumentsWhereGivenUserHasAssignedTasks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
assignedUserLogin (required)
Path Parameter — Assigned user login
Query parameters
filter (optional)
Query Parameter — Status filter
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of DocumentRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tasks/{assignedUserLogin}/parts
Get parts where user has assigned tasks (getPartsWhereGivenUserHasAssignedTasks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
assignedUserLogin (required)
Path Parameter — Assigned user login
Query parameters
filter (optional)
Query Parameter — Task status filter
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of PartRevisionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/tasks/{taskId}
Get task (getTask)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
taskId (required)
Path Parameter — Task id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TaskDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/tasks/{taskId}/process
Approve or reject task on document (processTask)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
taskId (required)
Path Parameter — Task id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Task process data
Responses
204
Successful task process
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/user-access
Set user access in workspace (setUserAccess)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — User to grant access in workspace
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated UserDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/user-group
Get user groups (getUserGroups)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserGroupDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/user-group
Create user group (createGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — UserGroup to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created UserGroupDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/user-group/{groupId}
Remove user group (removeGroup)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
groupId (required)
Path Parameter — Group id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
204
Successful removal of user from UserGroupDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/users
Get users (getUsersInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/users-stats
Get user stats for workspace (getUsersStats_3)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of users stats
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/users/admin
Get admin for workspace (getAdminInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/users/me
Get current user details (whoAmI)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of UserDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/users/{login}/tag-subscriptions
Get tag subscriptions of user (getTagSubscriptionsForUser)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
login (required)
Path Parameter — User login
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of TagSubscriptionDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName}
Update or create tag subscription of user (updateUserSubscription)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
login (required)
Path Parameter — User login
tagName (required)
Path Parameter — Tag name
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Tag subscription to update or create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful retrieval of created/updated TagSubscriptionDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/users/{login}/tag-subscriptions/{tagName}
Delete tag subscription of user (deleteUserSubscription)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
login (required)
Path Parameter — User login
tagName (required)
Path Parameter — Tag name
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion of TagSubscriptionDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/webhooks
Get webhooks (getWebhooks)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WebhookDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/webhooks
Create webhook (createWebhook)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Webhook definition
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful creation of webhook
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/webhooks/{webhookId}
Get webhook (getWebhook)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
webhookId (required)
Path Parameter — Webhook id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WebhookDTO
401
Unauthorized
404
Not found
500
Internal server error
Up
put /workspaces/{workspaceId}/webhooks/{webhookId}
Update webhook (updateWebhook)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
webhookId (required)
Path Parameter — Webhook id
Request body
body (required)
Body Parameter — Webhook definition
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
successful operation
201
Successful update of webhook
401
Unauthorized
404
Webhook not found
500
Internal server error
Up
delete /workspaces/{workspaceId}/webhooks/{webhookId}
Delete webhook (deleteWebhook)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
webhookId (required)
Path Parameter — Webhook id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
201
Successful delete of webhook
401
Unauthorized
404
Webhook not found
500
Internal server error
Up
get /workspaces/{workspaceId}/workflow-instances/{workflowId}
Get instantiated workflow (getWorkflowInstance)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowId (required)
Path Parameter — Workflow id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkflowDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/workflow-instances/{workflowId}/aborted
Get workflow's aborted workflow list (getWorkflowAbortedWorkflowList)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowId (required)
Path Parameter — Workflow id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkflowDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/workflow-models
Get workflow models (getWorkflowModelsInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkflowModelDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/workflow-models
Create workflow model (createWorkflowModel)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — Workflow model to create rules to set
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of created WorkflowModelDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/workflow-models/{workflowModelId}
Get workflow model (getWorkflowModelInWorkspace)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowModelId (required)
Path Parameter — Workflow model id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkflowModelDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/workflow-models/{workflowModelId}
Update workflow model (updateWorkflowModel)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowModelId (required)
Path Parameter — Workflow model id
Request body
body (required)
Body Parameter — Workflow model to update
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of updated WorkflowModelDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/workflow-models/{workflowModelId}
Delete workflow model (delWorkflowModel)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowModelId (required)
Path Parameter — Workflow model id
Responses
204
Successful deletion of WorkflowModelDTO
401
Unauthorized
500
Internal server error
Up
put /workspaces/{workspaceId}/workflow-models/{workflowModelId}/acl
Update workflow model ACL (updateWorkflowModelACL)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workflowModelId (required)
Path Parameter — Workflow model id
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — ACL rules to set
Responses
204
Successful update of WorkflowModelDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/workspace-workflows
Get workspace workflow list (getWorkspaceWorkflowList)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceWorkflowDTOs. It can be an empty list.
401
Unauthorized
500
Internal server error
Up
post /workspaces/{workspaceId}/workspace-workflows
Instantiate workspace workflow from workflow model (createWorkspaceWorkflow)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
Request body
body (required)
Body Parameter — Workspace workflow to create
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceWorkflowDTO
401
Unauthorized
500
Internal server error
Up
get /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId}
Get workspace workflow (getWorkspaceWorkflow)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workspaceWorkflowId (required)
Path Parameter — Workspace workflow id
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Successful retrieval of WorkspaceWorkflowDTO
401
Unauthorized
500
Internal server error
Up
delete /workspaces/{workspaceId}/workspace-workflows/{workspaceWorkflowId}
Delete a workspace workflow (deleteWorkspaceWorkflow)
Path parameters
workspaceId (required)
Path Parameter — Workspace id
workspaceWorkflowId (required)
Path Parameter — Workspace workflow id
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
Successful deletion operation
401
Unauthorized
500
Internal server error
[ Jump to Methods ]
Table of Contents
ACLDTOACLEntryDTOAccountDTOActivityDTOActivityModelDTOBaselinedDocumentDTOBaselinedDocumentOptionDTOBaselinedPartDTOBaselinedPartOptionDTOBinaryResourceDTOCADInstanceDTOCascadeResultChangeIssueDTOChangeIssueListDTOChangeOrderDTOChangeRequestDTOChangeRequestListDTOComponentDTOConfigurationItemDTOConfigurationItemKeyConversionDTOCountDTODateBasedEffectivityDTODiskUsageSpaceDTODocumentBaselineDTODocumentCreationDTODocumentIterationDTODocumentIterationLinkDTODocumentIterationListDTODocumentMasterTemplateDTODocumentRevisionDTODocumentTemplateCreationDTOEffectivityDTOFileFileDTOFolderDTOGCMAccountDTOImportDTOImportPreviewDTOInstanceAttributeDTOInstanceAttributeTemplateDTOIterationNoteDTOLayerDTOLeafDTOLightPartLinkDTOLightPartLinkListDTOLightPartMasterDTOLightPartRevisionDTOLightPathToPathLinkDTOListOfValuesDTOLoginRequestDTOLotBasedEffectivityDTOMarkerDTOMilestoneDTOModificationNotificationDTONameValuePairDTOOAuthLoginRequestDTOOAuthProviderPublicDTOOrganizationDTOPartCreationDTOPartIterationDTOPartIterationListDTOPartMasterTemplateDTOPartRevisionDTOPartSubstituteLinkDTOPartTemplateCreationDTOPartUsageLinkDTOPasswordRecoverDTOPasswordRecoveryRequestDTOPathChoiceDTOPathDTOPathDataIterationCreationDTOPathDataIterationDTOPathDataMasterDTOPathListDTOPathToPathLinkDTOPlatformOptionsDTOProductBaselineDTOProductConfigurationDTOProductInstanceCreationDTOProductInstanceIterationDTOProductInstanceMasterDTOQueryContextDTOQueryDTOQueryRuleDTOResolvedPartLinkDTORoleDTORoleMappingDTOSerialNumberBasedEffectivityDTOSharedDocumentDTOSharedPartDTOStatsOverviewDTOTagDTOTagListDTOTagSubscriptionDTOTaskDTOTaskModelDTOTaskProcessDTOTemplateGeneratedIdDTOUserDTOUserGroupDTOWebhookAppParameterDTOWebhookDTOWorkflowDTOWorkflowModelDTOWorkspaceBackOptionsDTOWorkspaceDTOWorkspaceDetailsDTOWorkspaceFrontOptionsDTOWorkspaceListDTOWorkspaceUserGroupMemberShipDTOWorkspaceUserMemberShipDTOWorkspaceWorkflowCreationDTOWorkspaceWorkflowDTO
userEntries
array[ACLEntryDTO] Users ACL entries
groupEntries
array[ACLEntryDTO] Groups ACL entries
userEntriesMap
map[String, String]
userGroupEntriesMap
map[String, String]
key
String Member id
value
String ACL permission value
FORBIDDEN
READ_ONLY
FULL_ACCESS
login
String Login of the account
password
String Password of the account
name
String Name of the account
email
String Email of the account
language
String Language of the account
timeZone
String Timezone of the account
admin
Boolean Account administrator flag
enabled
Boolean Account enabled flag
newPassword
String Password for password change or create action
providerId
Integer Provider id if account is provided
step
Integer Activity step
relaunchStep
Integer Activity relaunch step
tasks
array[TaskDTO] List of the tasks
lifeCycleState
String Final lifecycle state
type
String Workflow type
SEQUENTIAL
PARALLEL
tasksToComplete
Integer Tasks to complete
complete
Boolean Complete flag
stopped
Boolean Stopped flag
inProgress
Boolean In progress flag
toDo
Boolean Todo flag
step
Integer Activity model step
relaunchStep
Integer Activity model relaunch step
taskModels
array[TaskModelDTO] List of task models
lifeCycleState
String Final lifecycle state
type
String Type of the workflow model
SEQUENTIAL
PARALLEL
tasksToComplete
Integer Amount of tasks to complete
documentMasterId
String Document master id
title
String Document title
version
String Document version
iteration
Integer Document iteration
availableIterations
array[BaselinedDocumentOptionDTO] Document available iterations
version
String Entity version
lastIteration
Integer Entity last iteration
released
Boolean Entity released flag
obsolete
Boolean Entity obsolete flag
number
String Part number
name
String Part name
version
String Part version
iteration
Integer Part iteration
availableIterations
array[BaselinedPartOptionDTO] Part available iterations
version
String Part version
lastIteration
Integer Part last iteration
released
Boolean Part released flag
fullName
String Resource full path
name
String Resource name
contentLength
Long Resource size
lastModified
Date Resource last modification date
rx
Double Rotation around x Axis
ry
Double Rotation around y Axis
rz
Double Rotation around z Axis
tx
Double Translation on x Axis
ty
Double Translation on y Axis
tz
Double Translation on z Axis
matrix
array[Double] 4x4 Transformation matrix
rotationType
String Transformation type
ANGLE
MATRIX
succeedAttempts
Integer
failedAttempts
Integer
id
Integer Change item id
name
String Change item name
workspaceId
String Workspace id
author
String Change item author login
authorName
String Change item author name
assignee
String Change item assignee user login
assigneeName
String Change item assignee user name
creationDate
Date Change item creation date
description
String Change item description
priority
String Change item priority
LOW
MEDIUM
HIGH
EMERGENCY
category
String Change item category
ADAPTIVE
CORRECTIVE
PERFECTIVE
PREVENTIVE
OTHER
affectedDocuments
array[DocumentIterationDTO] Change item affected documents
affectedParts
array[PartIterationDTO] Change item affected parts
tags
array[String] Change item tag list
acl
ACLDTO Change item ACL
writable
Boolean Change item writable flag
initiator
String Login of initiator
issues
array[ChangeIssueDTO] The list of issues
id
Integer Change item id
name
String Change item name
workspaceId
String Workspace id
author
String Change item author login
authorName
String Change item author name
assignee
String Change item assignee user login
assigneeName
String Change item assignee user name
creationDate
Date Change item creation date
description
String Change item description
priority
String Change item priority
LOW
MEDIUM
HIGH
EMERGENCY
category
String Change item category
ADAPTIVE
CORRECTIVE
PERFECTIVE
PREVENTIVE
OTHER
affectedDocuments
array[DocumentIterationDTO] Change item affected documents
affectedParts
array[PartIterationDTO] Change item affected parts
tags
array[String] Change item tag list
acl
ACLDTO Change item ACL
writable
Boolean Change item writable flag
addressedChangeRequests
array[ChangeRequestDTO] Change order addressed request
milestoneId
Integer Change order due milestone
id
Integer Change item id
name
String Change item name
workspaceId
String Workspace id
author
String Change item author login
authorName
String Change item author name
assignee
String Change item assignee user login
assigneeName
String Change item assignee user name
creationDate
Date Change item creation date
description
String Change item description
priority
String Change item priority
LOW
MEDIUM
HIGH
EMERGENCY
category
String Change item category
ADAPTIVE
CORRECTIVE
PERFECTIVE
PREVENTIVE
OTHER
affectedDocuments
array[DocumentIterationDTO] Change item affected documents
affectedParts
array[PartIterationDTO] Change item affected parts
tags
array[String] Change item tag list
acl
ACLDTO Change item ACL
writable
Boolean Change item writable flag
addressedChangeIssues
array[ChangeIssueDTO] Change request addressed issues
milestoneId
Integer Change request due milestone
requests
array[ChangeRequestDTO] The list of change requests
author
String Part author name
authorLogin
String Part author login
number
String Part number
name
String Part name
version
String Part version
iteration
Integer Part iteration
description
String Part description
standardPart
Boolean Standard part flag
assembly
Boolean Assembly flag
substitute
Boolean Substitute flag
partUsageLinkId
String Component usage link id
partUsageLinkReferenceDescription
String Component usage link description
components
array[ComponentDTO] List of children components
amount
Double Amount of component
unit
String Unit for amount
attributes
array[InstanceAttributeDTO] List of part iteration attributes
checkOutUser
UserDTO Check out user if any
checkOutDate
Date Check out date if any
released
Boolean Released flag
obsolete
Boolean Obsolete flag
optional
Boolean Optional flag
lastIterationNumber
Integer Last part iteration number
accessDeny
Boolean Denied access flag
substituteIds
array[String] Available substitutes list
notifications
array[ModificationNotificationDTO] Hooked modifications notifications
hasPathData
Boolean Contains structure path data flag
path
String Component path in context
virtual
Boolean
id
String Configuration item id
workspaceId
String Workspace id
description
String Configuration item description
designItemNumber
String Configuration item root part number
designItemName
String Configuration item root part name
designItemLatestVersion
String Configuration item root part latest version
author
UserDTO Configuration item author
hasModificationNotification
Boolean Hooked modification notifications
pathToPathLinks
array[PathToPathLinkDTO] List of structure path links
workspace
String
id
String
endDate
Date Conversion end date
startDate
Date Conversion start date
succeed
Boolean Success flag
pending
Boolean Pending flag
count
Integer Count value
typeEffectivity
String Discriminator of the effectivity type
SERIALNUMBERBASEDEFFECTIVITY
DATEBASEDEFFECTIVITY
LOTBASEDEFFECTIVITY
startNumber
String Start number of the Serial Number
endDate
Date End date of the Effectivity
startLotId
String Start number of the Lot
name
String Name of the effectivity
configurationItemKey
ConfigurationItemKey Configuration Item Key linked to the effectivity
description
String Description of the effectivity
endNumber
String End number of the Serial Number
endLotId
String End number of the Lot
id
Integer Id of the effectivity
startDate
Date Start date of the Effectivity
documents
Long Storage size for document files
parts
Long Storage size for part files
documentTemplates
Long Storage size for documentTemplates files
partTemplates
Long Storage size for partTemplates files
id
Integer Baseline id
name
String Baseline name
description
String Baseline description
creationDate
Date Baseline creation date
type
String Baseline type
LATEST
RELEASED
baselinedDocuments
array[BaselinedDocumentDTO] Baselined document list
author
UserDTO Baseline author
workspaceId
String Workspace id
reference
String Document master id
version
String Document version
type
String Document type
title
String Document title
description
String Document description
workflowModelId
String Workflow id to use
templateId
String Workflow to instantiate
path
String Folder path
roleMapping
array[RoleMappingDTO] Role mapping for workflow instantiation
acl
ACLDTO ACL to set on document
workspaceId
String Workspace id
id
String Document iteration id
documentMasterId
String Document master id
version
String Document version
iteration
Integer Document iteration
creationDate
Date Document creation date
modificationDate
Date Document modification date
checkInDate
Date Document check in date
title
String Document title
author
UserDTO Document author
revisionNote
String Revision note
attachedFiles
array[BinaryResourceDTO] Document iteration attached files
instanceAttributes
array[InstanceAttributeDTO] Document iteration attributes
linkedDocuments
array[DocumentRevisionDTO] Document iteration linked documents
documentRevision
DocumentRevisionDTO
workspaceId
String Workspace id
documentMasterId
String Target document master id
version
String Target document version
iteration
Integer Target document iteration
title
String Target document title
commentLink
String Comment
documents
array[DocumentIterationDTO] List of document iterations
workspaceId
String Workspace id
id
String Document master template id
documentType
String Document master template type
author
UserDTO Document master template author
creationDate
Date Document master template creation date
modificationDate
Date Document master template modification date
idGenerated
Boolean Is generated flag
mask
String Document master template mask
workflowModelId
String Workflow id to use when instantiating documents from template
attachedFiles
array[BinaryResourceDTO] Document master template attached files
attributeTemplates
array[InstanceAttributeTemplateDTO] Document master template attribute templates
attributesLocked
Boolean Attribute templates locked flag
acl
ACLDTO Document master template ACL
workspaceId
String Workspace id
id
String Document key
documentMasterId
String Document master id
version
String Document version
type
String Document type
author
UserDTO Document author
creationDate
Date Document creation date
commentLink
String Document comment link
title
String Document title
checkOutUser
UserDTO Document check out user
checkOutDate
Date Document check out date
tags
array[String] Document tag list
description
String Document description
iterationSubscription
Boolean Subscribe iteration notifications flag
stateSubscription
Boolean Subscribe state notifications flag
documentIterations
array[DocumentIterationDTO] Document iterations list
workflow
WorkflowDTO Document instantiated workflow
workflowId
Integer Document instantiated workflow id
path
String Document folder
routePath
String Document folder route
lifeCycleState
String Current lifecycle state
publicShared
Boolean Public shared flag
attributesLocked
Boolean Attributes locked flag
status
String Document status
WIP
RELEASED
OBSOLETE
obsoleteDate
Date Obsolete date
obsoleteAuthor
UserDTO Obsolete author
releaseDate
Date Released date
releaseAuthor
UserDTO Released author
acl
ACLDTO Document ACL
lastIteration
DocumentIterationDTO
workspaceId
String Workspace id
reference
String Document template id
documentType
String Document template type
idGenerated
Boolean Document template generate mode
mask
String Document template mask
workflowModelId
String Document template associated workflow id
attachedFiles
array[BinaryResourceDTO] Document template attached files
attributeTemplates
array[InstanceAttributeTemplateDTO] Document template attribute templates
attributesLocked
Boolean Document template attributes locked flag
id
Integer Id of the effectivity
name
String Name of the effectivity
description
String Description of the effectivity
configurationItemKey
ConfigurationItemKey Configuration Item Key linked to the effectivity
typeEffectivity
String Discriminator of the effectivity type
SERIALNUMBERBASEDEFFECTIVITY
DATEBASEDEFFECTIVITY
LOTBASEDEFFECTIVITY
startNumber
String Start number of the Serial Number
endNumber
String End number of the Serial Number
startDate
Date Start date of the Effectivity
endDate
Date End date of the Effectivity
startLotId
String Start number of the Lot
endLotId
String End number of the Lot
path
String
name
String
parent
String
absolute
Boolean
canonicalPath
String
parentFile
File
absolutePath
String
absoluteFile
File
canonicalFile
File
directory
Boolean
file
Boolean
hidden
Boolean
totalSpace
Long
freeSpace
Long
usableSpace
Long
created
Boolean Created flag
fullName
String File path and name
shortName
String File name
path
String Folder full path
id
String Folder id
name
String Folder name
home
Boolean Folder home flag
login
String Account login
gcmId
String GCM account id
id
String Import id
fileName
String Imported file name
endDate
Date Import end date
startDate
Date Import start date
succeed
Boolean Success flag
pending
Boolean Pending flag
errors
array[String] Potential errors
warnings
array[String] Potential warnings
partRevsToCheckout
array[LightPartRevisionDTO] Part revisions that will be checked out
partsToCreate
array[PartCreationDTO] Part masters that will be created
workspaceId
String Workspace id
name
String Instance attribute name
mandatory
Boolean Mandatory flag
locked
Boolean Locked flag
type
String Instance attribute type
TEXT
NUMBER
DATE
BOOLEAN
URL
LOV
LONG_TEXT
PART_NUMBER
value
String Instance attribute value
lovName
String Instance attribute LOV name
items
array[NameValuePairDTO] Instance attribute LOV items
name
String Attribute template name
mandatory
Boolean Mandatory flag
attributeType
String Attribute template type
TEXT
NUMBER
DATE
BOOLEAN
URL
LOV
LONG_TEXT
PART_NUMBER
lovName
String Attribute template LOV name
locked
Boolean Locked flag
iterationNote
String Iteration note value
id
Integer Layer id
name
String Layer name
color
String Layer color as hexadecimal
id
String Instance id
partIterationId
String Part iteration id
path
String Complete path in structure
matrix
array[Double] Transformation matrix
qualities
Integer Level of details available
getxMin
Double Bounding box X axis lower value
getyMin
Double Bounding box Y axis lower value
getzMin
Double Bounding box Z axis lower value
getxMax
Double Bounding box X axis upper value
getyMax
Double Bounding box Y axis upper value
getzMax
Double Bounding box Z axis upper value
files
array[BinaryResourceDTO] All available files
number
String Part number
name
String Part name
referenceDescription
String Link description
fullId
String Complete component path in context
partLinks
array[LightPartLinkDTO] The list of light part links
partNumber
String Part number
partName
String Part name
workspaceId
String Workspace id
partNumber
String Part number
version
String Part version
id
Integer Path to path link id
type
String Path to path link type
sourcePath
String Path to path link source path
targetPath
String Path to path link target path
description
String Path to path link description
workspaceId
String Workspace id
name
String LOV name
values
array[NameValuePairDTO] LOV values
id
String LOV id
deletable
Boolean
login
String Account login
password
String Account password
typeEffectivity
String Discriminator of the effectivity type
SERIALNUMBERBASEDEFFECTIVITY
DATEBASEDEFFECTIVITY
LOTBASEDEFFECTIVITY
startNumber
String Start number of the Serial Number
endDate
Date End date of the Effectivity
startLotId
String Start number of the Lot
name
String Name of the effectivity
configurationItemKey
ConfigurationItemKey Configuration Item Key linked to the effectivity
description
String Description of the effectivity
endNumber
String End number of the Serial Number
endLotId
String End number of the Lot
id
Integer Id of the effectivity
startDate
Date Start date of the Effectivity
id
Integer Marker id
title
String Marker title
description
String Marker description
x
Double
y
Double
z
Double
id
Integer Milestone id
title
String Milestone title
dueDate
Date Milestone due date
description
String Milestone description
workspaceId
String Workspace id
numberOfRequests
Integer Milestone associated requests count
numberOfOrders
Integer Milestone associated orders count
acl
ACLDTO Milestone ACL
writable
Boolean Milestone writable flag
id
Integer Modification notification id
impactedPartNumber
String Impacted part number
impactedPartVersion
String Impacted part version
modifiedPartNumber
String Modified part number
modifiedPartName
String Modified part name
modifiedPartVersion
String Modified part version
modifiedPartIteration
Integer Modified part iteration
checkInDate
Date Modified part check in date
iterationNote
String Modified part iteration note
author
UserDTO Modifications author
acknowledged
Boolean Acknowledged flag
ackComment
String Acknowledged comment
ackAuthor
UserDTO Acknowledged author
ackDate
Date Acknowledged date
name
String Pair name
value
String Pair value
accessToken
String Access token
idToken
String Auth token
state
String State
tokenType
String Token type
nonce
String Nonce
providerId
Integer Provider id
id
Integer Id of the auth provider
name
String Name of the auth provider
enabled
Boolean Enabled state of the auth provider
issuer
String Base url of the auth provider
clientID
String Provider client ID
jwsAlgorithm
String Provider algorithm
jwkSetURL
String Provider jwk set url
redirectUri
String Redirect uri
authority
String Authority
scope
String Scope
responseType
String Response type
authorizationEndpoint
String Authorization end point
signingKeys
String Signing keys
secret
String Provider client secret
name
String Name of the organization
description
String Description of the organization
workspaceId
String Workspace id
number
String Part number
version
String Part version
name
String Part name
description
String Part description
workflowModelId
String Workflow to instantiate
standardPart
Boolean Standard part flag
templateId
String Template to use
roleMapping
array[RoleMappingDTO] Role mapping for instantiated workflow
acl
ACLDTO Part ACL
workspaceId
String Workspace id
iteration
Integer Part iteration
nativeCADFile
BinaryResourceDTO Native CAD file
geometryFileURI
String 3D file URI
iterationNote
String Iteration note
author
UserDTO Part author
creationDate
Date Creation date
modificationDate
Date Modification date
checkInDate
Date Checkin date
instanceAttributes
array[InstanceAttributeDTO] Part iteration attributes
instanceAttributeTemplates
array[InstanceAttributeTemplateDTO] Attribute templates for structure path data
components
array[PartUsageLinkDTO] List of children components
linkedDocuments
array[DocumentRevisionDTO] Part iteration linked documents
number
String Part number
name
String Part name
version
String Part version
attachedFiles
array[BinaryResourceDTO] Part attached files
parts
array[PartIterationDTO] The list of part iterations
workspaceId
String Workspace id
id
String Part template id
reference
String Part template reference
partType
String Part template type
author
UserDTO Part template author
creationDate
Date Part template creation date
modificationDate
Date Part template modification date
idGenerated
Boolean Generate id flag
mask
String Part template mask
attachedFile
String Part template attached files
attributeTemplates
array[InstanceAttributeTemplateDTO] Part template attributes
attributeInstanceTemplates
array[InstanceAttributeTemplateDTO] Part template structure path attributes
attributesLocked
Boolean Attributes locked flag
workflowModelId
String Workflow to instantiate on part creation
acl
ACLDTO Part template ACL
lastIterationNumber
Integer Part last iteration number
partKey
String Part key
number
String Part number
version
String Part name
type
String Part version
name
String Part name
author
UserDTO Part author
creationDate
Date Part creation date
modificationDate
Date Part modification date
checkInDate
Date Part check in date
description
String Part description
partIterations
array[PartIterationDTO] Part iteration list
checkOutUser
UserDTO Part check out user if any
checkOutDate
Date Part check out date if any
workflow
WorkflowDTO Instantiated workflow if any
lifeCycleState
String Current lifecycle state
standardPart
Boolean Standard part flag
workspaceId
String Workspace id
publicShared
Boolean Public shared flag
acl
ACLDTO Part ACL
attributesLocked
Boolean Attributes locked flag
status
String Part status
WIP
RELEASED
OBSOLETE
tags
array[String] Part tag list
notifications
array[ModificationNotificationDTO] Hooked modification notifications
obsoleteDate
Date Obsolete date
obsoleteAuthor
UserDTO Obsolete author
releaseDate
Date Released date
releaseAuthor
UserDTO Released author
id
Integer Part substitute link id
fullId
String Complete path in context
amount
Double Amount of component
unit
String Unit for amount
referenceDescription
String Link description
comment
String Link comment
substitute
ComponentDTO Substitute component
cadInstances
array[CADInstanceDTO] Component CAD instances
workspaceId
String Workspace id
reference
String Part template reference
partType
String Part template type
idGenerated
Boolean Generate id flag
mask
String Part template mask
attachedFiles
String Part template attached files
attributeTemplates
array[InstanceAttributeTemplateDTO] Part template attributes
attributeInstanceTemplates
array[InstanceAttributeTemplateDTO] Part template attribute templates
attributesLocked
Boolean Attributes locked flag
workflowModelId
String Workflow to instantiate for part creation
id
Integer Part usage link id
fullId
String Complete path in context
amount
Double Amount for usage
comment
String Link comment
component
ComponentDTO Component used
referenceDescription
String Link description
unit
String Unit for amount
optional
Boolean Optional link flag
cadInstances
array[CADInstanceDTO] List of CAD instances
substitutes
array[PartSubstituteLinkDTO] List of substitute links
uuid
String Token for password recovery
newPassword
String New password to use
login
String Account login for password recovery
resolvedPath
array[ResolvedPartLinkDTO] Complete path in context
partUsageLink
PartUsageLinkDTO Path concerned by the choice
id
Integer Path data iteration id
path
String Complete path in context
iteration
Integer Path data iteration number
iterationNote
String Path data iteration note
attachedFiles
array[String] Path data iteration attached files
linkedDocuments
array[DocumentRevisionDTO] Path data iteration linked documents
instanceAttributes
array[InstanceAttributeDTO] Path data iteration attributes
serialNumber
String Product instance serial number
pathDataMasterId
Integer Path data master id
iteration
Integer Path data iteration number
iterationNote
String Path data iteration note
partLinksList
LightPartLinkListDTO List of part links
path
String Complete path in context
attachedFiles
array[BinaryResourceDTO] Path data iteration attached files
linkedDocuments
array[DocumentRevisionDTO] Path data iteration linked documents
instanceAttributes
array[InstanceAttributeDTO] Path data iteration attributes
id
Integer Path data master id
path
String Complete path in context
serialNumber
String Product instance serial number
partLinksList
LightPartLinkListDTO List of part links
pathDataIterations
array[PathDataIterationDTO] Path data master iterations
partAttributes
array[InstanceAttributeDTO] Path data master attributes
partAttributeTemplates
array[InstanceAttributeTemplateDTO] Path data master attribute templates
configSpec
String Config spec in use
paths
array[String] Path values
id
Integer Path to path link id
type
String Path to path link type
sourceComponents
array[LightPartLinkDTO] Source path
targetComponents
array[LightPartLinkDTO] Target path
description
String Link description
registrationStrategy
String Registration strategy
NONE
ADMIN_VALIDATION
workspaceCreationStrategy
String Workspace creation strategy
NONE
ADMIN_VALIDATION
id
Integer Baseline id
name
String Baseline name
description
String Baseline description
creationDate
Date Baseline creation date
configurationItemId
String Configuration item in use
configurationItemLatestRevision
String Configuration item latest revision
type
String Baseline type
LATEST
RELEASED
baselinedParts
array[BaselinedPartDTO] Baselined part list
substituteLinks
array[String] Baseline substitute links used, as id list
optionalUsageLinks
array[String] Baseline optional links retained, as id list
substitutesParts
array[LightPartLinkListDTO] Baseline substitutes links, as part list
optionalsParts
array[LightPartLinkListDTO] Baseline optional links retained, as part list
author
UserDTO Baseline author
hasObsoletePartRevisions
Boolean Baseline has obsolete parts flag
pathToPathLinks
array[PathToPathLinkDTO] Baseline path to path links in structure
id
Integer Product configuration id
configurationItemId
String Configuration item id
name
String Product configuration name
description
String Product configuration description
substituteLinks
array[String] Product configuration substitute links list
optionalUsageLinks
array[String] Product configuration optional links retained list
creationDate
Date Product configuration creation date
author
UserDTO Product configuration author
substitutesParts
array[LightPartLinkListDTO] Product configuration substitute links list
optionalsParts
array[LightPartLinkListDTO] Product configuration optional links retained list
acl
ACLDTO Product configuration ACL
serialNumber
String Product instance serial number
configurationItemId
String Configuration item in use
baselineId
Integer Baseline in use
acl
ACLDTO Product instance ACL
instanceAttributes
array[InstanceAttributeDTO] Product instance attributes
linkedDocuments
array[DocumentRevisionDTO] Product instance linked documents
attachedFiles
array[BinaryResourceDTO] Product instance attached files
serialNumber
String Product instance serial number
iteration
Integer Product instance iteration
iterationNote
String Product instance iteration note
configurationItemId
String Configuration item used
updateAuthor
String Product instance last update author login
updateAuthorName
String Product instance last update author name
modificationDate
Date Product instance last modification date
baselinedParts
array[BaselinedPartDTO] Product instance baselined parts
substituteLinks
array[String] Product instance substitute links retained
optionalUsageLinks
array[String] Product instance optional links retained
author
UserDTO Product instance author
creationDate
Date Product instance creation date
substitutesParts
array[LightPartLinkListDTO] Product instance substitute links retained as parts
optionalsParts
array[LightPartLinkListDTO] Product instance optional links retained as parts
pathToPathLinks
array[PathToPathLinkDTO] Product instance path to path links in structure
basedOn
ProductBaselineDTO Product instance baseline in use
pathDataMasterList
array[PathDataMasterDTO] Product instance path data list
pathDataPaths
array[LightPartLinkListDTO] Product instance path data locations
instanceAttributes
array[InstanceAttributeDTO] Product instance attributes
linkedDocuments
array[DocumentRevisionDTO] Product instance linked documents
attachedFiles
array[BinaryResourceDTO] Product instance attached files
identifier
String Product instance identifier
serialNumber
String Product instance serial number
configurationItemId
String Configuration item used
productInstanceIterations
array[ProductInstanceIterationDTO] Product instance iterations
acl
ACLDTO Product instance ACL
workspaceId
String Workspace id
serialNumber
String Product instance serial number in use
configurationItemId
String Configuration item in use
id
Integer Query id
name
String Query name
creationDate
Date Query creation date
queryRule
QueryRuleDTO Part iteration query rule
pathDataQueryRule
QueryRuleDTO Path data query rule
selects
array[String] List of select statements
orderByList
array[String] List of order by statements
groupedByList
array[String] List of grouped by statements
contexts
array[QueryContextDTO] Query context list
condition
String Rule condition
id
String Rule id
field
String Rule field
type
String Rule type
operator
String Rule operator
values
array[String] Rule values
rules
array[QueryRuleDTO] Rule sub rules
subQueryRules
array[QueryRuleDTO]
partIteration
PartIterationDTO Resolved part iteration
partLink
LightPartLinkDTO Usage Link
id
String Role id
name
String Role name
workspaceId
String Workspace id
defaultAssignedUsers
array[UserDTO] Default assigned users for role
defaultAssignedGroups
array[UserGroupDTO] Default assigned groups for role
roleName
String Role name
userLogins
array[String] Mapped users
groupIds
array[String] Mapped groups
typeEffectivity
String Discriminator of the effectivity type
SERIALNUMBERBASEDEFFECTIVITY
DATEBASEDEFFECTIVITY
LOTBASEDEFFECTIVITY
startNumber
String Start number of the Serial Number
endDate
Date End date of the Effectivity
startLotId
String Start number of the Lot
name
String Name of the effectivity
configurationItemKey
ConfigurationItemKey Configuration Item Key linked to the effectivity
description
String Description of the effectivity
endNumber
String End number of the Serial Number
endLotId
String End number of the Lot
id
Integer Id of the effectivity
startDate
Date Start date of the Effectivity
uuid
String Shared document token
workspaceId
String Workspace id
password
String Shared document password
expireDate
Date Shared document expired date
userLogin
String Shared document creator
documentMasterId
String Shared document maser id
documentMasterVersion
String Shared document version
uuid
String Shared part token
workspaceId
String Workspace id
password
String Shared part password
expireDate
Date Shared part expire date
userLogin
String Shared part login creator
partMasterNumber
String Shared part number
partMasterVersion
String Shared part version
documents
Integer Documents count
parts
Integer Parts count
products
Integer Products count
users
Integer Users count
id
String Tag id
label
String Tag label
workspaceId
String Workspace id
tags
array[TagDTO] The list of tags
tag
String Tag name
onIterationChange
Boolean Iteration change flag
onStateChange
Boolean State change flag
closureComment
String Task closure comment
title
String Task title
instructions
String Task instructions
targetIteration
Integer Task entity target iteration
closureDate
Date Task closure date
signature
String Task signature
assignedUsers
array[UserDTO] Task assigned users
assignedGroups
array[UserGroupDTO] Task assigned groups
worker
UserDTO Task effective worker
status
String Task status
NOT_STARTED
IN_PROGRESS
APPROVED
REJECTED
NOT_TO_BE_DONE
workspaceId
String Workspace id
workflowId
Integer Task parent workflow
activityStep
Integer Task parent activity step
num
Integer Task num
holderType
String Task holder type
holderReference
String Task holder reference
holderVersion
String Task holder version
num
Integer Task model num
title
String Task model title
instructions
String Task model instructions
role
RoleDTO Task model assigned role
duration
Integer Task model duration
action
String Task process action
APPROVE
REJECT
comment
String Task process comment
signature
String Task process signature
id
String Generated id for template
workspaceId
String Workspace id
login
String User login
name
String User name
email
String User email
language
String User language
membership
String User workspace membership
READ_ONLY
FULL_ACCESS
id
String User group id
workspaceId
String Workspace id
name
String Webhook app parameter name
value
String Webhook app parameter value
id
Integer Webhook id
name
String Webhook name
active
Boolean Webhook active flag
parameters
array[WebhookAppParameterDTO] Webhook parameters list
appName
String Webhook app name
id
Integer Workflow id
finalLifeCycleState
String Workflow final lifecycle state
activities
array[ActivityDTO] Workflow activity list
abortedDate
Date Workflow aborted date if aborted
lifeCycleState
String
currentActivity
ActivityDTO
currentStep
Integer
id
String Workflow model id
reference
String Workflow model reference
finalLifeCycleState
String Workflow model final lifecycle state
author
UserDTO Workflow model author
creationDate
Date Workflow model creation date
acl
ACLDTO Workflow model ACL
activityModels
array[ActivityModelDTO] Workflow model activity model list
workspaceId
String Workspace id
sendEmails
Boolean Send emails flag
id
String Workspace id
description
String Workspace description
folderLocked
Boolean Folder locked flag
enabled
Boolean Workspace enabled flag
id
String Workspace id
admin
String Workspace admin login
description
String Workspace description
partTableColumns
array[String] Part table columns
documentTableColumns
array[String] Document table columns
administratedWorkspaces
array[WorkspaceDTO] Administrated workspace list
allWorkspaces
array[WorkspaceDTO] All workspace list
workspaceId
String Workspace id
memberId
String Group concerned
readOnly
Boolean Read only flag
workspaceId
String Workspace id
member
UserDTO User concerned
readOnly
Boolean Read only flag
id
String Workspace workflow id
workflowModelId
String Workflow model to use
roleMapping
array[RoleMappingDTO] Role mapping for instantiated workflow
workspaceId
String Workspace id
id
String Workspace workflow id
workflow
WorkflowDTO Workspace workflow instance