SOAP API - queryProcessInstancesAlt

The table summarizes the SOAP API - queryProcessInstancesAlt.

Request Uses the queryProcessInstancesAltInput element (from the ProcessManagement schema)
Parameter notes
  • select, where, orderBy: For information about valid SQL syntax, see Sorting and Filtering Lists of Process Templates and Instances.
  • attributeMap: If a user-defined attribute is used in the select parameter 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 (see the example below).
  • 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.)
  • statusMode: (Optional) Filters process instances returned according to their current status. The valid entries are ACTIVE, TERMINATED, or ACTIVE_AND_TERMINATED. Default = ACTIVE.
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:queryProcessInstancesAltInput>
         <proc:select>INSTANCE.NAME,INSTANCE.ID,Issue</proc:select>
         <proc:where>INSTANCE.STATUS = 'SUSPENDED'</proc:where>
         <proc:orderBy>INSTANCE.START_DATE</proc:orderBy>
         <proc:pageSize>10</proc:pageSize>
         <proc:attributeMap>
            <proc:templateAttribute>
               <proc:name>Issue</proc:name>
               <proc:type>string</proc:type>
            </proc:templateAttribute>
         </proc:attributeMap>
      </proc:queryProcessInstancesAltInput>
   </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>InternalHelpDesk</processName>
               </processQName>
               <id>pvm:0a12u</id>
               <customAttributes>
                  <customAttribute>
                     <name>Issue</name>
                     <value>Forgot password</value>
                  </customAttribute>
               </customAttributes>
            </processInstance>
         </processInstances>
         <pagingID>-94865740</pagingID>
      </queryProcessInstancesOutput>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>