SOAP API Reference › Web Services Methods › getStartRequestForms

getStartRequestForms

Use this method to search the start request forms in a CA Process Automation library. A search is based on the path and keyword provided.

Example

With /root as the lookup path

<tns:getStartRequestForms 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:filter>
<tns:lookUpPath isRecursive="true">/</tns:lookUpPath>
<tns:keywords>
<tns:keyword>ABC</tns:keyword>
</tns:keywords>
</tns:filter>
</tns:getStartRequestForms>

To obtain all the start request forms in the environment

Provide / and remove the Keyword__ from the Keyword tags:

<tns:getStartRequestFormsResponse xmlns:tns="http://www.ca.com/itpam">
<startRequests>
<tns:startRequest name="Start Purchase Request Form" refPath="/PAM Hardware Procurement/">
<tns:description/>
</tns:startRequest>
<tns:startRequest name="Asset_Install_SW_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</tns:startRequest>
<tns:startRequest name="Asset_MAC_HW_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</tns:startRequest>
<tns:startRequest name="Asset_Transfer_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</tns:startRequest>
<tns:startRequest name="Asset_Disposal_HW_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</tns:startRequest>
<tns:startRequest name="Asset_Install_HW_Transferred_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</tns:startRequest>
<tns:startRequest name="Asset_Install_HW_SRF" refPath="/sinra1/CA ITAM/SRF/">
<tns:description>Database Object</tns:description>
</startRequest>
<tns:startRequest name="~Start Request Form" refPath="/Package Demo/">
<tns:description/>
</tns:startRequest>
<tns:startRequest name="~Start Request Form" refPath="/Jack/">
<tns:description/>
</tns:startRequest>
</tns:startRequests>
</tns:getStartRequestFormsResponse>

Perform a keyword search

You can search start request forms with keywords that are associated with them. For example, you can perform a search to find if SRF1 and SRF2 are associated with the keyword "ABC" in the folder /myfolder.

<tns:getStartRequestForms xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:filter>
<tns:lookUpPath isRecursive="true">/myfolder</tns:lookUpPath>
<tns:keywords>
<tns:keyword>ABC</tns:keyword>
</tns:keywords>
</tns:filter>
</tns:getStartRequestForms>

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:getStartRequestForms xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:filter>
<tns:lookUpPath isRecursive="true">/</tns:lookUpPath>
<tns:keywords>
<tns:keyword>ABC</tns:keyword>
</tns:keywords>
</tns:filter>
</tns:getStartRequestForms>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

This tag is present in the <filter> tag:

• <lookUpPath> provides the path under which the user wants to search the start request forms. One attribute in this tag is recursive. If a user wants to search recursively under the provided path, then set this attribute true. If a user wants to search only under the provided path, set this attribute as false. Provide the complete path (as /Folder/Folder1) as the value of this tag in which user wants to search.

SOAP Response

<getStartRequestFormsResponse xmlns="http://www.ca.com/itpam">
<startRequests>
<startRequest name="SRF1" refPath="/TENSU03/">
<description/>
</startRequest>
<startRequest name="SRF2" refPath="/TENSU03/">
<description/>
</startRequest>
</startRequests>
</getStartRequestFormsResponse>

For every start request form that fulfills the criteria for the search, there is a <startRequest> under the <startRequests> tag. This tag contains the name, reference path, and description of the start request form in the SOAP response.