Authenticates the specified login for the specified vault and returns the authentication token and status.
Gets the specified BOM.
Gets the computed BOM.
Gets the weldment cut list BOM.
Gets all vaults from the vault configuration file.
Gets the data card for the specified file, file version, and vault.
Saves the data card for the specified file and vault.
Gets the data card for the specified folder and vault.
Uses the specified URI to get information.
Uses the specified URI to post information.
Uses the specified URI to save information.
Uses the specified URI to patch information.
Uses the specified URI to delete information.
Gets information about the specified file.
Gets the active configuration of the specified file.
Gets the reference tree of the specified file.
Gets the configurations of the specified file.
Gets the link to download a file.
Gets extended file information.
Gets the top level file references of the specified file.
Gets the link to download a file thumbnail.
Gets the specified file's variables.
Gets the parents of the specified file.
Gets the BOM information for the specified file.
Gets the state transitions for the specified file.
Gets the specified file's version information.
Deletes the specified file
Gets the tree of references in the specified file's checkout.
Builds the reference tree to undo the checkout of the specified file.
Checks out the specified file.
Gets information about multiple files.
Unlocks the specified file.
Gets information for the specified folder.
Gets the files and folders in the specified folder.
Deletes the specified folder.
Adds a folder to the specified folder.
Gets information about specified folders in the specified vault.
Gets the groups in the specified vault.
Gets information about the specified group.
Sends the specified message.
Marks a notification as read.
Gets the user notifications.
Gets the result of the specified operation.
Gets the status of the specified operation.
Gets a changeset ID for the specified vault.
Checks in the specified changeset.
Uploads files to the specified changeset for checkin.
Builds a reference tree of files that are uploaded to the specified changeset.
Adds files in the specified changeset to the vault.
Uploads a changeset.
Gets all references for the specified file and transition.
Gets the transitions available for the specified file.
Gets information about the specified transition.
Changes the state of the specified documents.
Gets the users to notify when the specified items undergo the specified transition.
Gets the comment histories for specified files that undergo the specified transition.
Gets the transitions available for multiple files.
Gets the users of the specified vault.
Gets information about the specified user.
Gets extended information about the specified user.
Saves information about the specified user.
Gets the picture of the specified user.
Saves the picture of the specified user.
Deletes the picture of the specified user.
Gets the properties of the specified vault.
Deletes the specified items in the specified vault.
Gets objects in the specified vault.
Gets objects in the vault that contain the specified string.
Gets the version of this web application.
Gets the workflows in the specified vault.
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
Thank you for your comments. We will contact you if we have questions regarding your feedback.
Sincerely,The SOLIDWORKS Documentation Team
Print Topic
Select the scope of content to print:
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.
Web Help Content Version: API Help (English only) 2022 SP05 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.