REST API - queryProcessTemplates

The table summarizes the REST API - queryProcessTemplates.

Request

Format
GET <baseurl>/process/query/template/<query>/<pagesize>
Path parameters
  • query: Full (SQL syntax) query string. The "FROM process" clause should be included in the query.

    For information about valid SQL syntax, see Sorting and Filtering Lists of Process Templates and Instances .

  • pagesize: Page size to be used to return the list of process templates. One of the following values:
    • 0: Return the entire result set in a single, non-paged list.
    • -1: Return the result set in a paged list, using the default page size.
    • positive integer: return the result set in a paged list, with the specified number of items on each page.

      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

JSON Returns a JSON representation of the content of the queryProcessTemplatesOutput element.
XML Returns the content of the queryProcessTemplatesOutput element (from the ProcessManagement schema).

Example

Request
GET <baseurl>/process/query/template/SELECT%20*%20FROM%20process%20WHERE%20DEFINITION.NAME%3D'CSCallbackProcess'%20ORDER%20BY%20DEFINITION.VERSION/0
Response
{
   "processTemplates": {
      "processTemplate": {
         "basicTemplate": {
            "processQName": {
               "moduleName": "/CSCallback/Process Packages/CSCallback.xpdl",
               "processName": "CSCallbackProcess",
               "version": "1.0.0.201210231048"
            },
            "description": null
         },
         "priority": "NORMAL",
         "creationTime": "2013-01-16T11:36:27.940-08:00"
      }
   },
   "pagingID": "0"
}