Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/state/{documentId}/transitions
PDM Pro API Web Service > State Transition Resource Group : api/{vaultName}/state/{documentId}/transitions (Get)
Description
Get available transitions for single file

 

Gets the transitions available for the specified file.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (required)string
documentId(URI parameter) Document ID (required)integer
TransitionId

(Response) Transition ID

 

Member of AvailableTransition model

integer
TransitionName

(Response) Transition name

 

Member of AvailableTransition model

 

string
Revoke

(Response) 1 if the parallel transition's approval is revokable, 0 if not

 

Member of AvailableTransition model

 

boolean
Commits

(Response) Whether commits

 

Member of AvailableTransition model

 

integer
Required

(Response) Whether required

 

Member of AvailableTransition model

 

integer
MustEnterComments

(Response) Whether must enter comments

 

Member of AvailableTransition model

 

boolean
Response (application/json, text/json)

Sample Data

[
  {
    "TransitionId": 1,
    "TransitionName": "sample string 2",
    "Revoke": true,
    "Commits": 4,
    "Required": 5,
    "MustEnterComments": true
  },
  {
    "TransitionId": 1,
    "TransitionName": "sample string 2",
    "Revoke": true,
    "Commits": 4,
    "Required": 5,
    "MustEnterComments": true
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfAvailableTransition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <AvailableTransition>
    <Commits>4</Commits>
    <MustEnterComments>true</MustEnterComments>
    <Required>5</Required>
    <Revoke>true</Revoke>
    <TransitionId>1</TransitionId>
    <TransitionName>sample string 2</TransitionName>
  </AvailableTransition>
  <AvailableTransition>
    <Commits>4</Commits>
    <MustEnterComments>true</MustEnterComments>
    <Required>5</Required>
    <Revoke>true</Revoke>
    <TransitionId>1</TransitionId>
    <TransitionName>sample string 2</TransitionName>
  </AvailableTransition>
</ArrayOfAvailableTransition>
Remarks
This operation can return an array of AvailableTransition 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}/transitions (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