SOAP API Reference › Web Services Methods › getPendingInteractionRequestForm

getPendingInteractionRequestForm

Use this method to retrieve information for a pending interaction request form that is based on the Task ID.

Example

<tns:getPendingInteractionRequestForm xmlns:tns="http://www.ca.com/itpam" getApprovalRequired="false" getParamSequence="false">
<tns:auth>
<!--xsd:Choice Type-->
<tns:token>token__</tns:token>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:userInteractionID>924</tns:userInteractionID>
</tns:getPendingInteractionRequestForm>

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:getPendingInteractionRequestForm xmlns:tns="http://www.ca.com/itpam" getApprovalRequired="false" getParamSequence="false">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:userInteractionID>924</tns:userInteractionID>
</tns:getPendingInteractionRequestForm>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

<userInteractionID> specifies the Task ID of the pending interaction request form.

<getPendingInteractionRequestForm> retrieves the sequence number of the parameters and sets the getParamSequence attribute value to "true".

SOAP Response

With proper values:

<getPendingInteractionRequestFormResponse xmlns="http://www.ca.com/itpam">
<processID>913</processID>
<isApprovalRequired>true</isApprovalRequired>
<description/>
<pages hasComplexType="false">
<page name="Parameters">
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_0" sequenceNo="0">
<label>Var_0</label>
<description/>
<value/>
</itpamString>
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_1" sequenceNo="1">
<label>Var_1</label>
<description/>
<value/>
</itpamString>
</page>
<page name="System"/>
<page name="User Prompt"/>
</pages>
</getPendingInteractionRequestFormResponse>

<pages> specifies the details of the pages in the interaction request form.

When provided a task in taken state:

<getPendingInteractionRequestFormResponse xmlns="http://www.ca.com/itpam">
<processID>7</processID>
<isApprovalRequired>true</isApprovalRequired>
<description/>
<pages hasComplexType="false">
<page name="Parameters">
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_0" sequenceNo="0">
<label>Var_0</label>
<description/>
<value/>
</itpamString>
<itpamString isReadOnly="false" maxlength="2147483647" minlength="0" name="Var_1" sequenceNo="1">
<label>Var_1</label>
<description/>
<value/>
</itpamString>
</page>
<page name="System"/>
<page name="User Prompt"/>
</pages>
</getPendingInteractionRequestFormResponse>

When provided a task in completed state:

<Fault xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>"UserInteraction with Task Id "<<taskid>>" is in completed state therefore this action is not allowed"
</faultstring>
</Fault>

Note: Starting with CA Process Automation r2.2, "getApprovalRequired" is added to "getPendingInteractionRequestForm" request. If it is set to true, then the "isApprovalRequired" flag returns, indicating if the form needs approval. To enable this behavior in CA Process Automation instances that were upgraded from r2.1, have your CA Process Automation Administrator perform the changes to the CA Process Automation configuration (described in the Note in "executePendingInformation Method").