Retrieve a Process Instance

Details

URI /processinstances/<process_instance_id>

Where <process_instance_id> is the process instance ID.

Method GET
Parameters

userIdentifier=<user_id>

Required; the user ID that you want to use as credentials for this API call. See Get userIdentifier for the steps required to get the userIdentifier value.

The user identified by userIdentifier must have admin access.
Response Body ProcessInstance VO
Returns

200 - Ok
401 - Not authorized

404 - Not found
500 - Server exception

The following was sent to retrieve a process instance:

https://<host>:<port>/csa/rest/processinstances/90d9652b3752ad4f013752ae38cb0065

The following XML was sent in the response:

<ProcessInstance>>
   <property>
     <isCriticalSystemObject>false</isCriticalSystemObject>
     <name>Unit Test Process Instance Property</name>
     <paramRoleType>
       <isCriticalSystemObject>false</isCriticalSystemObject>
       <name>INPUT</name>
       <disabled>false</disabled>
     </paramRoleType>
     <valueType>
       <isCriticalSystemObject>false</isCriticalSystemObject>
       <name>INPUT</name>
       <disabled>false</disabled>
     </valueType>
     <values>
       <value>Unit Test Process Instance Property Value</value>
     </values>
     <maxOccurs>0</maxOccurs>
     <minOccurs>0</minOccurs>
     <orderIndex>0</orderIndex>
     <confidential>false</confidential>
     <encrypted>false</encrypted>
     <readOnly>false</readOnly>
   </property>
   <processDefinition>
     <id>90d9652b35f41cbc0135f41cf1310004</id>
     <name>Unit Test Process Definition 1</name>
   </processDefinition>
   <processInstanceState>
     <isCriticalSystemObject>false</isCriticalSystemObject>
     <name>INITIALIZED</name>
     <disabled>false</disabled>
   </processInstanceState>
   <context>Context for Unit Test Process Instance</context>
   <artifactId>ID of the artifact executing the action</artifactId>
   <timeout>3600</timeout>
   <errorOnTimeout>false</errorOnTimeout>
 </ProcessInstance>