Description
Gets the transitions available for the specified file.
Parameters
Name | Description | Data Type |
vaultName | (Required URI parameter) Name of vault | string |
documentId | (Required URI parameter) File ID | integer |
folderId | (URI parameter) Folder ID, default is 0 | integer |
TransitionId | (Response) Transition ID
(Member of AvailableTransition Model) | integer |
TransitionName | (Response) Transition name
(Member of AvailableTransition Model)
| string |
Revoke | (Response) Whether a revoke
(Member of AvailableTransition Model)
| boolean |
Commits | (Response) Number of users who have performed this parallel transition; Commits <= Required
(Member of AvailableTransition Model)
| integer |
Required | (Response) Number of 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>
See Also