Hide Table of Contents
PDM Pro API Web Service
File Resource Group
PDM Pro API Web Service : File Resource Group
Description
Consists of APIs for working with files.
Operations
Getapi/{vaultName}/files/{fileId}/{version}
GET: api/{VaultName}/files/{FileID} or api/{VaultName}/files/{FileID}/{Version}/info Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/ActiveConfig
GET: api/{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: api/{VaultName}/files/{FileID}/{Version}/allreferences Get all file references

 

Gets the reference tree of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/configurations
GET: api/{VaultName}/files/{FileID}/{Version}/configurations Get file configurations

 

Gets the configurations of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/download
GET: api/{VaultName}/files/{FileID}/{Version}/download Get file

 

Gets the link to download a file.

Getapi/{vaultName}/files/{fileId}/{version}/info
GET: api/{VaultName}/files/{FileID} or api/{VaultName}/files/{FileID}/{Version}/info Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/info/extended
GET: api/{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: api/{VaultName}/files/{FileID}/{Version}/references Get file references

 

Gets the top level file references of the specified file.

Getapi/{vaultName}/files/{fileId}/{version}/thumbnails
GET: api/{VaultName}/files/{FileID}/{Version}/thumbnails

 

Gets the link to download a file thumbnail.

Getapi/{vaultName}/files/{fileId}/{version}/variables
GET: api/{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: api/{VaultName}/files/{FileID}/{Version}/whereused Get file where used

 

Gets the parents of the specified file.

Getapi/{vaultName}/files/{fileId}/bominfo?folderId={folderId}
GET: api/{VaultName}/files/{FileID}/bominfo Get file BOM info

 

Gets the BOM information for the specified file.

Getapi/{vaultName}/files/{fileId}/info?version={version}
GET: api/{VaultName}/files/{FileID} or api/{VaultName}/files/{FileID}/{Version}/info Get file info

 

Gets information about the specified file.

Getapi/{vaultName}/files/{fileId}/transitions?version={version}
GET: api/{VaultName}/files/{FileID}/transitions Get file transitions

 

Gets the state transitions for the specified file.

Getapi/{vaultName}/files/{fileId}/versions?folderId={folderId}
GET: api/{VaultName}/files/{FileID}/versions Get file version info

 

Gets the specified file's version information.

Deleteapi/{vaultName}/files/{fileId}?destroy={destroy}
DELETE: api/{VaultName}/files/{FileID} Delete file

 

Deletes the specified file

Getapi/{vaultName}/files/{fileId}?version={version}
GET: api/{VaultName}/files/{FileID} or api/{VaultName}/files/{FileID}/{Version}/info Get file info

 

Gets information about the specified file.

Putapi/{vaultName}/files/{parentFolderId}

 

Adds a file to the specified folder.

Postapi/{vaultName}/files/buildtree/checkout
POST: api/{VaultName}/files/buildtree/checkout Build checkout references tree

 

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

Postapi/{vaultName}/files/buildtree/undo
POST: api/{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
POST: api/{VaultName}/files/CheckOut Lock file

 

Checks out the specified file.

Postapi/{vaultName}/files/info
POST: api/{VaultName}/files/info

 

Gets information about multiple files.

Postapi/{vaultName}/files/UndoCheckOut
POST: api/{VaultName}/files/UndoCheckOut Undo lock file

 

Unlocks the specified file.

See Also
PDM Pro API Web Service



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:   File 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) 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.

0.20.30