SOAP API - queryProcessTemplatesAlt

The table summarizes the SOAP API - queryProcessTemplatesAlt.

Request Uses the queryProcessTemplatesAltInput 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 .
  • 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.)
  • willSave ( optional, boolean ): indicate whether terminated process instances should be saved. If not specified, it will be false.
  • saveDuration (optional, duration ): The duration specified in XSD duration format for which the terminated process will be saved. For example, use P30D to save it for 30 days after reaching the final state like completed or canceled. If not specified, it will be indefinite.
Response Returns a queryProcessTemplatesOutput 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:queryProcessTemplatesAltInput>
         <proc:select>DEFINITION.CREATION_DATE</proc:select>
         <proc:where>DEFINITION.NAME='WelcomeUsers'</proc:where>
         <proc:orderBy></proc:orderBy>
         <proc:pageSize>0</proc:pageSize>
      </proc:queryProcessTemplatesAltInput>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <queryProcessTemplatesOutput xmlns="http://www.tibco.com/bx/2009/management/processManagerType">
         <processTemplates>
            <processTemplate>
               <creationTime>2011-06-29T07:29:58.943-07:00</creationTime>
            </processTemplate>
            <processTemplate>
               <creationTime>2011-06-29T08:30:30.543-07:00</creationTime>
            </processTemplate>
         </processTemplates>
         <pagingID>0</pagingID>
      </queryProcessTemplatesOutput>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>