REST API - queryProcessTemplatesAlt

The table summarizes the REST API - queryProcessTemplatesAlt.

Request

Format
GET <baseurl>/process/query/templatealt/<select>/<pagesize>
Path parameters
  • select: Attributes to be selected for each process template in the result set.
  • 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.)

Query parameters

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/templatealt/DEFINITION.CREATION_DATE/2?where=DEFINITION.NAME%3D'WelcomeUsers'&orderby=DEFINITION.PRIORITY
Response
{
  "xml-fragment": {
    "proc:processTemplates": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "proc:processTemplate": [
        { "proc:creationTime": "2013-01-29T13:11:22.867-08:00" },
        { "proc:creationTime": "2013-01-29T13:01:19.427-08:00" }
      ]
    },
    "proc:pagingID": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "#text": "-1729060952"
    }
  }
}