SOAP API Reference › Web Services Methods › controlInstance

controlInstance

Use this method to create a SOAP request to control an instance. The controlInstance method specifies archiving for the process or start request forms (and all its child instances) that are not triggered in detached mode. This method does not send a fault if a process or start request form is already marked for archiving. The controlInstance method sends a fault when a process or start request form is not found with the specified ID.

To execute a controlInstance method, use any one of the following options:

• rootUUID: This option specifies the rootUUID of the process or start request form
• instanceId: This option specifies the instance ID of the process or start request form
• tagId: This option specifies the tagid of the process or start request form.

Example

<tns:controlInstance xmlns:tns="http://www.ca.com/itpam"> 
  <tns:auth> 
<!--xsd:Choice Type--> 
<tns:token>token__</tns:token> 
<tns:user>user__</tns:user> 
<tns:password>password__</tns:password> 
  </tns:auth> 
  <!--xsd:Choice Type--> 
  <tns:instanceId>instanceId__</tns:instanceId> 
  <tns:action>archive</tns:action> 
</tns:controlInstance> 

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:itp="http://www.ca.com/itpam">
   <soapenv:Header/>
   <soapenv:Body>
      <tns:controlInstance>
        <tns:auth>
	<!--xsd:Choice Type-->
	<tns:token>token__</tns:token>
         <tns:user>Joe</tns:user>
         <tns:password>thisismypassword</tns:password>
        <tns:auth>
	<!--xsd:Choice Type-->
        <tns:instanceId>3186</tns:instanceId>
        <tns:action>archive</tns:action>
      </tns:controlInstance>
   </soapenv:Body>
</soapenv:Envelope>

<rootUUID> specifies the rootUUID of the process/start request form.

<instanceId> specifies the instance ID of the process/start request form.

<tagId> specifies the tagid of the process/start request form.

<action> specifies the action to perform on the process/start request form instance. Currently, only archive is supported.

SOAP Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <controlProcessResponse xmlns="http://www.ca.com/itpam">
         <actionStatus>The archive action was successfully executed.</actionStatus>
      </controlProcessResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>