SOM - Service Desk

Query Process Instance Details

Query detailed information about a process instance with the specified ID.

Interface URI

/som/processInstance/{id}

Access Method

HTTP
GET
Parameters
Path parameters
id Process instance ID.
Long integer type. Required. No default value.

Return Values

Status codes
  • 200 (OK): Success.
Message header
HTTP/1.1 200 OK
Message body
<processInstance>
<id>1</id>
<executionId>Request Process.20001</executionId>
<state>1</state>
<componentId>INC-SOM-SERVICEDESK</componentId>
<componentKey>id</componentKey>
<componentValue>1</componentValue>
<description/>
<dispexeuid>Request Process.20001</dispexeuid>
</processInstance>
Element description
processInstance subelements
id Process instance ID.
Long integer type.
executionId Execution ID of the process instance.
String type.
state Execution status of the process instance. 0: Temporary data. 1: Available data.
Integer type.
componentId Component ID in INC . The default value is INC-SOM-SERVICEDESK.
String type.
componentKey Variable name, which is provided by the third-party service to uniquely identify the process instance for easy maintenance.
String type.
componentValue Value of the variable name, which is provided by the third-party service to uniquely identify the process instance for easy maintenance.
String type.
description Description of the process instance.
String type.
dispexeuid Output of the execution ID for the process instance.
String type.

Example

Query detailed information about the process instance with ID 1.

Request
GET http://host:8080/imcrs/som/processInstance/1
accept: application/xml
...        
Response
HTTP/1.1 200 OK
Content-Type: application/xml
...
<processInstance>
<id>1</id>
<executionId>Request Process.20001</executionId>
<state>1</state>
<componentId>INC-SOM-SERVICEDESK</componentId>
<componentKey>id</componentKey>
<componentValue>1</componentValue>
<description/>
<dispexeuid>Request Process.20001</dispexeuid>
</processInstance>