SOAP API - setAvailableProcessInstanceVariables

The table summarizes the SOAP API - setAvailableProcessInstanceVariables.

Request Uses the setAvailableProcessInstanceVariablesInput element (from the ProcessManagement schema)
Parameter notes
  • processID can be obtained from queryHaltedProcessInstances.

    The specified process instance must be in a HALTED state for the request to be valid. An illegalStateFault is returned if the process instance is in any other state.

  • variableMap is a set of name/value pairs for the variables to be set. The available variables can be obtained from getAvailableProcessInstanceVariables.
Response Returns a success element (from the ProcessManagement schema)
Example Request: 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">

   <soapenv:Header/>

   <soapenv:Body>

      <proc:setAvailableProcessInstanceVariablesInput>

         <proc:processID>pvm:0a124</proc:processID>

         <proc:variableMap>

            <proc:variable>

               <proc:name>CustID</proc:name>

               <proc:value>REF1234</proc:value>

            </proc:variable>

            <proc:variable>

               <proc:name>CustName</proc:name>

               <proc:value>Heston</proc:value>

            </proc:variable></proc:variableMap>

      </proc:setAvailableProcessInstanceVariablesInput>

   </soapenv:Body>

</soapenv:Envelope>
Response: 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

   <SOAP-ENV:Header/>

   <SOAP-ENV:Body>

      <proc:success xmlns:proc="http://www.tibco.com/bx/2009/management/processManagerType">OK</proc:success>

   </SOAP-ENV:Body>

</SOAP-ENV:Envelope>
Contents
Search Results