SOAP API Reference › Web Services Methods › executeStartRequest

executeStartRequest

Use this method to start a start request form from the CA Process Automation library.

Example

<tns:executeStartRequest 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>
<tns:objLocation>
<tns:name>MYSRF</tns:name>
<tns:path>/myfolder/</tns:path>
</tns:objLocation>
<tns:params>
<tns:param name="Var_0">joe</tns:param>
<tns:param name="Var_1">smith</tns:param>
</tns:params>
<tns:options>
<tns:startDate>startDate__</tns:startDate>
<tns:startTime>startTime__</tns:startTime>
<tns:tagId> 06a4d113-0333-4aba-8cce-8781c18647c9</tns:tagId>
<tns:isAutoArchive>true</tns:isAutoArchive>
<tns:priority>priority__</tns:priority>
</tns:options>
<tns:attachments attachmentsParamName="attachmentsParamName__">
<tns:attachment>
<tns:attachmentID>attachmentID__</tns:attachmentID>
<tns:name>name_11__</tns:name>
<tns:localSourceLocation>localSourceLocation__</tns:localSourceLocation>
</tns:attachment>
</tns:attachments>
</tns:executeStartRequest>

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:executeStartRequest xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:objLocation>
<tns:name>MYSRF</tns:name>
<tns:path>/TENSU03/</tns:path>
</tns:objLocation>
<tns:params>
<tns:param name="Var_0">user</tns:param>
<tns:param name="Var_1">joe</tns:param>
</tns:params>
<tns:options>
<tns:startDate>startDate__</tns:startDate>
<tns:startTime>startTime__</tns:startTime>
<tns:tagId>06a4d113-0333-4aba-8cce-8781c18647c9</tns:tagId>
<tns:isAutoArchive>true</tns:isAutoArchive>
<tns:priority>priority__</tns:priority>
</tns:options>
<tns:attachments attachmentsParamName="attachmentsParamName__">
<tns:attachment>
<tns:attachmentID>attachmentID__</tns:attachmentID>
<tns:name>name_11__</tns:name>
<tns:localSourceLocation>localSourceLocation__</tns:localSourceLocation>
</tns:attachment>
</tns:attachments>
</tns:executeStartRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<objLocation> specifies the location of the start request form in the CA Process Automation library. Two tags are under the <objLocation> tag.

<name> specifies the name of the start request form.

<path> provides the absolute path of the start request form object in the CA Process Automation Library.

<tagId> Adds a unique ID to a process/Start Request Form. A fault returns if there is a process or start request form instance with same tag. The <tagId> tag monitors the status of any process/start request form that you specify the tag for.

<IsAutoArchive> tag can be set to false to skip process/start request form instances (along with their child instances) from archiving under archival policy. Processes that are run in detached mode are not affected by this tag. The default value for <IsAutoArchive> is true.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<executeStartRequestResponse xmlns="http://www.ca.com/itpam">
<startRequestStatus>
<interactionId>114</interactionId>
<state>Running</state>
<earliest-start-time>2012-03-01T00:00:00.000+05:30</earliest-start-time>
<start-time>2012-03-01T13:54:13.523+05:30</start-time>
<refProcess>/TENSU03/Process</refProcess>
<params>
<param name="DisableSchedulingDialog">True</param>
<param name="FLowChartPath">/TENSU03/Process</param>
<param name="userId">pamadmin</param>
<param name="CALLER_TYPE">ITPAM_WS</param>
<param name="Var_1">tentu</param>
<param name="Var_0">sudhakar</param>
</params>
</startRequestStatus>
</executeStartRequestResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<interactionId> specifies the interaction Id of the instance of start request form started.

<state> shows the state of the instance.

<refProcess> is the name of the process with the absolute path attached with the start request form.