SOAP API Reference › Web Services Methods › executePendingInteraction

executePendingInteraction

Use this method to execute the pending user interactions.

Example

<tns:executePendingInteraction 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:params>
<tns:param name="Var_0">hello</tns:param>
<tns:param name="Var_1">world</tns:param>
</tns:params>
<tns:userInteractionID>22141</tns:userInteractionID>
<tns:isApprove>true</tns:isApprove>
</tns:executePendingInteraction>

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:executePendingInteraction xmlns:tns="http://www.ca.com/itpam">
<tns:auth>
<tns:user>Joe</tns:user>
<tns:password>thisismypassword</tns:password>
<tns:auth>
<tns:params>
<tns:param name="Var_0">hello</tns:param>
<tns:param name="Var_1">world</tns:param>
</tns:params>
<tns:userInteractionID>22141</tns:userInteractionID>
<tns:isApprove>true</tns:isApprove>
</tns:executePendingInteraction>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

To provide a parameter

In the previous request, the user can provide a list of parameters under the <params> tag. The user must create one <param> tag which includes the following parameters:

Name attribute of this tag

Provide the name of the parameter.

Value of this tag

Provide the value of the parameter.

<userInteractionID> is the ID of the Task Id of the user interaction execute.

<isApprove> specifies to approve or reject the task. This value can be true or false. This tag is optional.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<executePendingInteractionResponse xmlns="http://www.ca.com/itpam">
<userInteractionID>22141</userInteractionID>
<interactionTitle>Task_MyTasks</interactionTitle>
<state>Completed</state>
<startTime>2012-02-29T18:11:28.817+05:30</startTime>
<endTime>2012-02-29T18:17:27.707+05:30</endTime>
<parmitedUserGroup>pamadmin</parmitedUserGroup>
<closedBy>pamadmin</closedBy>
</executePendingInteractionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope> 

<userInteractionID> specifies the Id of the interaction request.

<interactionTitle> specifies the title of the interaction request.

<state> specifies the state of the interaction request.

<startTime> specifies the start time of the interaction request.

<endTime> specifies the end time of the interaction request.

<parmitedUserGroup> shows the list of assigned users and groups.

<closedBy> shows the name of the user who responded to the task.

Note: The "IsApprove flag" was being ignored for this method in CA Process Automation r2.1. To correct this issue, yet allow retention of the existing behavior for existing CA Process Automation instances, a new install has "oasis.reject.unnecessary.approval" set to true in the OasisConfig.properties configuration file. Existing installations have oasis.reject.unnecessary.approval added to set to the OasisConfig.properties configuration file and set to false.

If "oasis.reject.unnecessary.approval" is true, then the server considers the isApprove flag. A fault is returned if the user tries to approve or reject a form which does not require approval. A fault is also returned if the SOAP message does not include the isApprove flag for a form which requires approval.