SOAP API - queryHaltedProcessInstances

The table summarizes the SOAP API - queryHaltedProcessInstances.

Request Uses the queryProcessInstancesInput element (from the ProcessManagement schema)
Parameter notes
  • query: For information about valid SQL syntax, see Sorting and Filtering Lists of Process Templates and Instances .

    You cannot use INSTANCE.STATUS in the query’s condition expression. If you do, an error will be returned. (The operation itself restricts the query to instances WHERE INSTANCE.STATUS = ’HALTED’.)

  • attributeMap: If a user-defined attribute is used in the SELECT statement of a paginated query, that attribute and its type should be included in the attributeMap, otherwise a database query must be made to get the type of the user-defined attribute, making the request less efficient.
  • pageSize: If you specify a paged result (pageSize = -1 or a number greater than 0), use the queryFirstPage , queryLastPage , queryNextPage , and queryPreviousPage operations to navigate the paged list, and queryDone to clear resources when you are finished with the paged list. (Note that the result limit for non-paginated queries (pageSize=0) is 500.)
Response Returns a queryProcessInstancesOutput 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:queryProcessInstancesInput>
         <proc:query>SELECT INSTANCE.ID, INSTANCE.NAME, ContactName FROM process</proc:query>
         <proc:pageSize>0</proc:pageSize>
         <proc:attributeMap>
            <proc:templateAttribute>
               <proc:name>ContactName</proc:name>
               <proc:type>String</proc:type>
            </proc:templateAttribute>
         </proc:attributeMap>
      </proc:queryProcessInstancesInput>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <queryProcessInstancesOutput xmlns="http://www.tibco.com/bx/2009/management/processManagerType">
         <processInstances>
            <processInstance>
               <processQName>
                  <processName>TestProcess</processName>
               </processQName>
               <id>pvm:0a125</id>
               <customAttributes>
                  <customAttribute>
                     <name>ContactName</name>
                     <value>John Morris</value>
                  </customAttribute>
               </customAttributes>
            </processInstance>
         </processInstances>
         <pagingID>0</pagingID>
      </queryProcessInstancesOutput>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>