Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/state/{documentId}/{folderId}/{transitionId}/references
PDM Pro API Web Service > State Transition Resource Group : api/{vaultName}/state/{documentId}/{folderId}/{transitionId}/references (Get)
Description
Get all references

 

Gets all references for the specified file and transition.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (required)string
documentId(URI parameter) Document ID (required)integer
folderId(URI parameter) Folder ID (required)integer
transitionId(URI parameter) Transition ID (required)integer
File

(Response) A FileInfoConfigLess object that consists of:

   File (File object that consists of FileId (integer) and FileName (string)

   )

   Folder (Folder object that consists of FolderId (integer) and FolderPath (string)

   )

   Version

 

Member of FileRefOfFileInfoConfigLess model

FileInfoConfigLess
IsToolbox

(Response) Whether in toolbox

 

Member of FileRefOfFileInfoConfigLess model

 

integer
ObjectType

(Response) "File", "Folder", or "Bom"

 

Member of FileRefOfFileInfoConfigLess model

 

String
Response (application/json)

Array of FileRefOfFileInfoConfigLess objects
Response (text/json)

Array of FileRefOfFileInfoConfigLess objects
Response (application/xml)

Array of FileRefOfFileInfoConfigLess objects
Response (text/xml)

Array of FileRefOfFileInfoConfigLess objects
See Also
State Transition Resource Group | 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:   api/{vaultName}/state/{documentId}/{folderId}/{transitionId}/references (Get)
*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