REST API - queryHaltedProcessInstances

The table summarizes the REST API - queryHaltedProcessInstances.

Request

Format 
GET <baseurl>/process/query/halted/instance/<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 .

    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’.)

  • pagesize: Page size to be used to return the list of process instances. 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 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 query parameters, otherwise a database query must be made to get the type of the user-defined attribute, making the request less efficient.
  • name=string (0..n): Name of the template attribute.
  • type=string (0..n): Data type of the template attribute.

Response

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

Example

Request 
GET <baseurl>/process/query/halted/instance/SELECT%20INSTANCE.ID%2C%20INSTANCE.NAME%2C%20ContactName%20FROM%20process/0?name=ContactName&type=String
Response 
{
  "xml-fragment": {
    "proc:processInstances": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "proc:processInstance": [
        {
          "proc:processQName": { "proc:processName": "ErrorTestsProcess" },
          "proc:id": "pvm:0a1212"
        },
        {
          "proc:processQName": { "proc:processName": "ErrorTestsProcess" },
          "proc:id": "pvm:0a1213"
        },
        {
          "proc:processQName": { "proc:processName": "ErrorTestsProcess" },
          "proc:id": "pvm:0a1215"
        }
      ]
    },
    "proc:pagingID": {
      "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
      "#text": "0"
    }
  }
}