SOAP API Reference › Web Services Methods › checkStartRequestStatus

checkStartRequestStatus

Use this method to see the status of a start request.

Example

<tns:checkStartRequestStatus xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type--> 
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<!--xsd:Choice Type--> 
<tns:interactionId>51</tns:interactionId>
<tns:tagId>tagId__</tns:tagId> 
</tns:checkStartRequestStatus>

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:checkStartRequestStatus xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<!--xsd:Choice Type-->
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:interactionId>51</tns:interactionId>
<tns:tagId>z34dsf5c7-xagb-4g5d-74g5-bd5c4we2378f</tns:tagId>
</tns:checkStartRequestStatus>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

You can include one of the following:

<interactionId>: The user passes the ID of the start request form to view.

<tagId>: The user passes the tagId of the start request form to view.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<checkStartRequestStatusResponse xmlns="http://www.ca.com/itpam">
<startRequestStatus>
<interactionId>51</interactionId>
<state>Completed</state>
<earliest-start-time>2012-03-01T12:51:25.690+05:30</earliest-start-time>
<start-time>2012-03-01T12:51:25.893+05:30</start-time>
<end-time>2012-03-01T12:51:38.033+05:30</end-time>
<refProcess>/TENSU03/Process</refProcess>
<processID>52</processID>
</startRequestStatus>
</checkStartRequestStatusResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

The response contains tags under which the user can see the result.

<state> describes the state of the start request.

<earliest-start-time> states the time when the start request is queued.

<start-time> states the actual start time of the start request.

<end-time> states the end time of the start request.

<refProcess> shows the reference path of the process that is attached with the start request.

<processID> shows the Instance Id of the process (only returned if a process instance has been created).