SOAP API Reference › Web Services Methods › getProcessStatus

getProcessStatus

Use this method to view the state of a process instance.

Example

<tns:getProcessStatus xmlns:tns="http://www.ca.com/itpam">
<tns:flow>
<!--xsd:Choice Type-->
<tns:ROID>489</tns:ROID>
<tns:action>check</tns:action>
<tns:auth>
<!--xsd:Choice Type-->
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
</tns:flow>
</tns:getProcessStatus>

SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<tns:getProcessStatus xmlns:tns="http://www.ca.com/itpam">
<tns:flow>
<tns:ROID>489</tns:ROID>
<tns:tagId>z34dsf5c7-xagb-4g5d-74g5-bd5c4we2378f</tns:tagId>
<tns:action>check</tns:action>
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
</tns:flow>
</tns:getProcessStatus>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You can include one of the following:

• <ROID> specifies the ROID of the process instance that you are viewing the state of.
• <tagId>: The user passes the tagId of the start request form to view.

<action> specifies the action to perform on the specified instance; the value of this tag must be "check".

SOAP Responses

Completed Process

<CheckFlowResponse xmlns="http://www.ca.com/itpam">
<CheckFlowResult>
<ROID>489</ROID>
<flow-state>Completed</flow-state>
<submission-time>2012-02-01T20:15:41.515+05:30</submission-time>
<sender-address>none</sender-address>
<connection-id>none</connection-id>
<message>Flow state received</message>
<params>
<param name="RuntimeROID">489</param>
<param name="Result">1</param>
<param name="ServerId">b9c4b8de-b74b-44b5-b2d2-1deb6e3dc872</param>
<param name="effectiveUser">pamadmin</param>
<param name="InstanceUUID">f120811e-3895-41a2-abbb-3458c19a51c8</param>
<param name="UserName">pamadmin</param>
<param name="ProcessName">/SOAPTest/P1</param>
<param name="ServerName">lodivsa204.ca.com</param>
<param name="DisplayName">P1</param>
<param name="TouchpointName">Orchestrator</param>
<param name="CallerUser">pamadmin</param>
<param name="EndDate">2012-02-01 16:30:24</param>
<param name="StartDate">2012-02-01 16:30:24</param>
<param name="ScheduledStartTime">2012-02-01 00:00:00</param>
<param name="rootUUID">f120811e-3895-41a2-abbb-3458c19a51c8</param>
<param name="EndTime">2012-02-01 16:30:24</param>
<param name="StartTime">2012-02-01 16:30:24</param>
<param name="ProcessAction">start</param>
<param name="InstanceName">P1_489</param>
</params>
</CheckFlowResult>
</CheckFlowResponse>

<flow-state> returns the state of the process instance.

Nonexistent or Archived Process

The operator fails with a fault and returns this response:

<Fault xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>The instance does not exist. It may have been archived. Refresh the screen.</faultstring>
</Fault>

Invalid Action

The operator fails with this fault:

<Fault xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>Invalid flow action: c</faultstring>
</Fault>

Invalid ROID

The operator fails with this fault:

<Fault xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>error retrieving flow state</faultstring>
</Fault>