Hide Table of Contents
PDM Pro API Web Service
File Resource Group
PDM Pro API Web Service : File Resource Group
Description
File services. You must send api/{vaultName}/authenticate before calling these. See Getting Started.
Operations
Getapi/{vaultName}/files/{fileId}/{folderId}/bominfo
GET: api/{VaultName}/files/{FileID}/bominfo Get file BOM infoGets the BOM information for the specified file.
Getapi/{vaultName}/files/{fileId}/{folderId}/history
Gets a specified file's history.
Getapi/{vaultName}/files/{fileId}/{folderId}/moves
Gets the history of moves for the specified file.
Getapi/{vaultName}/files/{fileId}/{folderId}/versions
GET: api/{VaultName}/files/{FileID}/versions Get file version info

 Gets the specified file's version information.

Deleteapi/{vaultName}/files/{fileId}/{folderId}?destroy={destroy}
Deletes the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{configId}/{folderId}/whereused?anyVersion={anyVersion}
GET: api/{VaultName}/files/{FileID}/{Version}/whereused Get file where usedGets the parent files where the specified file is used.
Getapi/{vaultName}/files/{fileId}/{version}/{configId}/whereused?folderId={folderId}&anyVersion={anyVersion}
GET: api/{VaultName}/files/{FileID}/{Version}/whereused Get file where usedGets the parent files where the specified file is used.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}
Gets information about the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/ActiveConfig
Gets the active configuration for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/allreferences?configId={configId}&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}/{folderId}/configurations
Gets the configurations for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/download
Gets the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/info
Gets information about the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/info/extended
Gets extended version information for a specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/references?configId={configId}
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}/{folderId}/thumbnails
Gets a specified file's thumbnail.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/transitions
Gets the file transitions for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/{folderId}/variables
Gets configuration variable information for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/ActiveConfig?folderId={folderId}
Gets the active configuration for 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?folderId={folderId}
Gets the configurations for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/download?folderId={folderId}
Gets the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/info/extended?folderId={folderId}
Gets extended version information for a specified file.
Getapi/{vaultName}/files/{fileId}/{version}/info?folderId={folderId}
Gets information about the specified file.
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?folderId={folderId}
Gets a specified file's thumbnail.
Getapi/{vaultName}/files/{fileId}/{version}/transitions?folderId={folderId}
Gets the file transitions for the specified file.
Getapi/{vaultName}/files/{fileId}/{version}/variables?folderId={folderId}
Gets configuration variable information for the specified file.
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}/{version}?folderId={folderId}
Gets information about 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}/history?folderId={folderId}
Gets a specified file's history.
Getapi/{vaultName}/files/{fileId}/info?version={version}&folderId={folderId}
Gets information about the specified file.
Getapi/{vaultName}/files/{fileId}/moves?folderId={folderId}
Gets the history of moves for the specified file.
Getapi/{vaultName}/files/{fileId}/transitions?version={version}&folderId={folderId}
Gets the file 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}?folderId={folderId}&destroy={destroy}
Deletes the specified file.
Getapi/{vaultName}/files/{fileId}?version={version}&folderId={folderId}
Gets information about the specified file.
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(s).

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

 

Gets information about the specified files.

Postapi/{vaultName}/files/infofrompath
Gets information about a file in the specified vault.
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) 2024 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.20