Hide Table of Contents
PDM Pro API Web Service
PDM Pro API Web Service
Description
The PDM Professional API Web Service consists of controllers and endpoints.
Authentication
Postapi/{vaultName}/authenticate
Use for the authenticate to get authentication token

 

Authenticates the specified login for the specified vault and returns the authentication token and status.

BOM
Configuration
Getapi/configuration/vaults?vaultName={vaultName}
Get all vaults from the config file

 

Gets all vaults from the vault configuration file.

Data Card
Getapi/{vaultName}/files/{fileId}/{version}/datacard?folderId={folderId}
Get file data card

 

Gets the data card for the specified file, file version, and vault.

Postapi/{vaultName}/files/{fileId}/datacard
Save file data card

 

Saves the data card for the specified file and vault.

Getapi/{vaultName}/folders/{folderId}/datacard
Get folder data card

 

Gets the data card for the specified folder and vault.

Default
Getapi/{uri}

 

Uses the specified URI to get information.

Postapi/{uri}

 

Uses the specified URI to post information.

Putapi/{uri}

 

Uses the specified URI to save information.

Patchapi/{uri}

 

Uses the specified URI to patch information.

Deleteapi/{uri}

 

Uses the specified URI to delete information.

File
Getapi/{vaultName}/files/{fileId}/{version}
Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/ActiveConfig
Get active configuration

 

Gets the active configuration of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/allreferences?configId={configId}&folderId={folderId}&includeSubParents={includeSubParents}
Get all file references

 

Gets the reference tree of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/configurations
Get file configurations

 

Gets the configurations of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/download
Get file

 

Gets the link to download a file.

Getapi/{vaultName}/files/{fileId}/{version}/info
Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/info/extended
Get file info extended

 

Gets extended file information.

Getapi/{vaultName}/files/{fileId}/{version}/references?configId={configId}&folderId={folderId}
Get file references

 

Gets the top level file references of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/thumbnails
Get file thumbnail

 

Gets the link to download a file thumbnail.

Getapi/{vaultName}/files/{fileId}/{version}/variables
Get file variables

 

Gets the specified file's variables.

Getapi/{vaultName}/files/{fileId}/{version}/whereused?configId={configId}&folderId={folderId}&anyVersion={anyVersion}
Get file where used

 

Gets the parents of the specified file.

Getapi/{vaultName}/files/{fileId}/bominfo?folderId={folderId}
Get file BOM info

 

Gets the BOM information for the specified file.

Getapi/{vaultName}/files/{fileId}/info?version={version}
Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/transitions?version={version}
Get file transitions

 

Gets the state transitions for the specified file.

Getapi/{vaultName}/files/{fileId}/versions?folderId={folderId}
Get file version info

 

Gets the specified file's version information.

Deleteapi/{vaultName}/files/{fileId}?destroy={destroy}
Delete file

 

Deletes the specified file

Getapi/{vaultName}/files/{fileId}?version={version}
Get file info

 

Gets information about the specified file.

Postapi/{vaultName}/files/buildtree/checkout
Build checkout references tree

 

Gets the tree of references in the specified file's checkout.

Postapi/{vaultName}/files/buildtree/undo
Build undo checkout references tree

 

Builds the reference tree to undo the checkout of the specified file.

Postapi/{vaultName}/files/CheckOut
Lock file

 

Checks out the specified file(s).

Postapi/{vaultName}/files/info
Get file info

 

Gets information about the specified files.

Postapi/{vaultName}/files/UndoCheckOut
Undo lock file

 

Unlocks the specified file.

Folder
Getapi/{vaultName}/folders/{folderId}
Get folder info

 

Gets information for the specified folder.

Getapi/{vaultName}/folders/{folderId}/browse
Get browse folder

 

Gets the files and folders in the specified folder.

Getapi/{vaultName}/folders/{folderId}/info
Get folder info

 

Gets information for the specified folder.

Deleteapi/{vaultName}/folders/{folderId}?destroy={destroy}
Delete folder

 

Deletes the specified folder.

Putapi/{vaultName}/folders/{parentFolderId}
Add folder

 

Adds a folder to the specified folder.

Postapi/{vaultName}/folders/info
Get folder info

 

Gets information about specified folders in the specified vault.

Group
Getapi/{vaultName}/groups
Get groups

 

Gets the groups in the specified vault.

Getapi/{vaultName}/groups/{groupId}
Get group info

 

Gets information about the specified group.

Getapi/{vaultName}/groups/{groupId}/info
Get group info

 

Gets information about the specified group.

Getapi/{vaultName}/groups/all
Get groups

 

Gets the groups in the specified vault.

Notification
Postapi/{vaultName}/notifications
Send message

 

Sends the specified message.

Postapi/{vaultName}/notifications/markRead
Mark message as read

 

Marks a notification as read.

Getapi/{vaultName}/notifications?all={all}&pageNo={pageNo}&pageSize={pageSize}
Get user notifications

 

Gets the user notifications.

Progress
Getapi/{vaultName}/progress/{guid}/result
Get operation result

 

Gets the result of the specified operation.

Getapi/{vaultName}/progress/{guid}/status
Get operation status

 

Gets the status of the specified operation.

Stage
Getapi/{vaultName}/changeset/create
Generate changesetId

 

Gets a changeset ID for the specified vault.

Putapi/{vaultName}/checkin/{changesetId}/{overrideVersion}
Check in files from the changeset

Checks in the specified changeset.

Putapi/{vaultName}/checkin/addfiles/{changesetId}
Upload files or document ids to changeset to the check in operation

 

Uploads files to the specified changeset for checkin.

Getapi/{vaultName}/checkin/buildtree/{changesetId}
Get references tree

 

Builds a reference tree of files that are uploaded to the specified changeset.

Putapi/{vaultName}/files/{changesetId}/finishadd
Finish of add file operation. This method adds files from changeset to the vault.

 

Adds files in the specified changeset to the vault.

Putapi/{vaultName}/files/{changesetId}/upload
Upload file to changeset to add files operations

 

Uploads a changeset.

State Transition
Getapi/{vaultName}/state/{documentId}/{folderId}/{transitionId}/references
Get all references

 

Gets all references for the specified file and transition.

Getapi/{vaultName}/state/{documentId}/transitions
Get available transitions for single file

 

Gets the transitions available for the specified file.

Getapi/{vaultName}/state/{transitionId}
Get transition info

 

Gets information about the specified transition.

Postapi/{vaultName}/state/{transitionId}/changestate?revoke={revoke}
Change state

 

Changes the state of the specified documents.

Postapi/{vaultName}/state/{transitionId}/DynamicNotificationUsers
Get dynamic notification users

 

Gets the users to notify when the specified items undergo the specified transition.

Postapi/{vaultName}/state/{transitionId}/HistoryComments
Get transition comment history for multiple files

 

Gets the comment histories for specified files that undergo the specified transition.

Postapi/{vaultName}/state/transitions
Get available transitions for multiple files

 

Gets the transitions available for multiple files.

Putapi/stage/{vaultName}/{documentId}?folderId={folderId}&overrideVersion={overrideVersion}

 

Checks in the specified document.

User
Getapi/{vaultName}/users
Get users

 

Gets the users of the specified vault.

Getapi/{vaultName}/users/{userId}
Get user info

 

Gets information about the specified user.

Getapi/{vaultName}/users/{userId}/Extended
Get user info extended

 

Gets extended information about the specified user.

Putapi/{vaultName}/users/{userId}/Extended
Set user info extended

 

Saves information about the specified user.

Getapi/{vaultName}/users/{userId}/info
Get user info

 

Gets information about the specified user.

Getapi/{vaultName}/users/{userId}/Picture
Get user picture

 

Gets the picture of the specified user.

Putapi/{vaultName}/users/{userId}/Picture
Put user picture

 

Saves the picture of the specified user.

Deleteapi/{vaultName}/users/{userId}/Picture
Delete user picture

 

Deletes the picture of the specified user.

Getapi/{vaultName}/users/all
Get users

 

Gets the users of the specified vault.

Vault
Getapi/{vaultName}
Get vault properties

 

Gets the properties of the specified vault.

Postapi/{vaultName}/delete/computetree
Delete compute tree

 

Deletes the specified items in the specified vault.

Getapi/{vaultName}/info
Get vault properties

 

Gets the properties of the specified vault.

Getapi/{vaultName}/search
Search vault

 

Gets objects in the specified vault.

Postapi/{vaultName}/search
Search vault

 

Gets objects in the vault that contain the specified string.

Version
Getapi/version/webapi
Get version

 

Gets the version of this web application.

Workflow
Getapi/{vaultName}/workflows
Get workflows

 

Gets the workflows in the specified vault.

Getapi/{vaultName}/workflows/icons
Get state icons

 

Gets the workflow state icons in the specified vault.



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   PDM Pro API Web Service
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2023 PR1

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.