Hide Table of Contents
PDM Pro API Web Service
Stage Resource Group
PDM Pro API Web Service : Stage Resource Group
Description
This resource group consists of HTTP requests for uploading and checking in files to your PDM Pro vault. You must send api/{vaultName}/authenticate before calling these. See Getting Started.
Operations
Getapi/{vaultName}/changeset/create
GET: api/{vaultName}/changeset/create Generate changesetId

 

Gets a changeset ID for the specified vault.

Putapi/{vaultName}/checkin/{changesetId}/{overrideVersion}
PUT: api/{vaultName}/checkin/{changesetId}/{overrideVersion=false} Check in files from the changeset

Checks in the specified changeset.

Putapi/{vaultName}/checkin/addfiles/{changesetId}
PUT: api/{vaultname}/checkin/addfiles/{changesetId=0} Upload files or document ids to changeset to the check in operation

 

Adds files to a changeset for checkin. (See Remarks)

Getapi/{vaultName}/checkin/buildtree/{changesetId}
GET: api/{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
PUT: api/{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. (See Remarks)

Putapi/{vaultName}/files/{changesetId}/upload
PUT: api/{vaultname}/files/{changesetId}/upload Upload file to changeset to add files operations

 

Uploads files to the specified changeset. (See Remarks)

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

 

Checks in the specified document.

See Also


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:   Stage Resource Group
*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) 2024 SP03

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.