REST API - queryFirstPage

The table summarizes the REST API - queryFirstPage.

Request

Format 
GET <baseurl>/process/query/first/<pagingid>
Path parameters pagingid: Identifies a particular set of data that can be paged (like a database cursor).

This is obtained when a query is paged by submitting -1 or a number greater than 0 for the pagesize parameter when calling the following: queryProcessInstances , queryProcessInstancesAlt , queryProcessTemplates , and queryProcessTemplatesAlt .

Response

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

Example

Request 
GET <baseurl>/process/query/first/1080687953
Response 
{
  "proc:processInstances": {
    "@xmlns:proc": "http://www.tibco.com/bx/2009/management/processManagerType",
    "proc:processInstance": [
      {
        "proc:customAttributes": {
          "proc:customAttribute": {
            "proc:name": "ContactName",
            "proc:value": "Bobbie Mill"
          }
        }
      },
      {
        "proc:customAttributes": {
          "proc:customAttribute": {
            "proc:name": "ContactName",
            "proc:value": "Annie Smith"
          }
        }
      }
    ]
  }
}