ProcessAdministrationTransitionStateRead
Extracts transition state data.
Usage
Use the ProcessAdministrationTransitionStateRead method to extract transition state data, including the field setup and related access control configuration data on the transition state. The Process Administration privilege is required.
You can query transition states using any of the following combinations of child elements of apQuery:TransitionState:
-
<RecordType>
-
<ProcessName>
-
<ProcessName> + <RecordType>
-
<ProcessName> + <RecordType> + <State>
If <State> is not specified, then all of the transition states for the specified process or record type are returned.
See ProcessAdministrationTransitionStateUpsert for information about the transition state data specified in apData:TransitionState.
Arguments
The following table describes the arguments taken by the ProcessAdministrationTransitionStateRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
|
apQuery:TransitionState |
The transition state query criteria. |
Yes |
Not applicable |
Input |
|
apData:ListOfTransitionState |
The extracted transition state data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The transition state data is returned.