SOAP API Reference › Web Services Methods › getStartRequestForm

getStartRequestForm

Use this method to retrieve information about a start request form that is based on the name and location of the start request form from the CA Process Automation library.

Example

<tns:getStartRequestForm xmlns:tns="http://www.ca.com/itpam" getParamSequence="true">
<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:getStartRequestForm>

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:getStartRequestForm xmlns:tns="http://www.ca.com/itpam" getParamSequence="true">
<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:getStartRequestForm>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

<path> is the absolute path of the folder where the start request form resides.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<getStartRequestFormResponse xmlns="http://www.ca.com/itpam">
<refProcess>/Joe/Process</refProcess>
<pages hasComplexType="false">
<page name="Page">
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_0" sequenceNo="0">
<label>Text Field</label>
<description/>
<value/>
</itpamString>
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_1" sequenceNo="1">
<label>Text Field</label>
<description/>
<value/>
</itpamString>
</page>
<page name="System"/>
</pages>
</getStartRequestFormResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<refProcess> shows the name and path of the process that is attached with this start request form.