REST interface for federated IBM BPM resources - Escalation Query Entity List Count Resource - GET Method

Use this method to retrieve the number of escalation entities in a query matching specified criteria.

Sample method invocation

GET /rest/bpm/federated/htm/v1/escalations/query/{query}/count[?domain={string}|systemID={string}][&queryFilter={string}][&processAppName={string}][&admin={boolean}]

Parameters

Required Federation Parameter

Name	Value Type	Description
domain	string	Name of the domain containing the BPEL runtime systems that host the distributed resource (mutually exclusive with the systemID parameter).
systemID	string	ID of the BPEL runtime system hosting the resource (mutually exclusive with the domain parameter). If specified then this request is treated like any other request for a resource hosted by a single system, that is, the request and the response are just routed, and no pre/post-processing of parameters and results is performed by the federation layer.

Optional Parameters

Name

Value Type

Description

queryFilter

string

A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query can be referenced.

processAppName

string

Name of the process application, which is used for additional filtering.

admin

boolean

Administration authorization option specifying whether the request is performed by an administrator.

Value	Description
true	The request is performed by an administrator. The user must have administrative rights to perform this request. If the `onBehalfUser` parameter is specified as well then the request is performed as if the specified user had sent the request, otherwise, the request runs as administrator.
false (default)	The request is performed by a regular user who doesn't have administrative rights.

Request Content

None

Response Content

Count of escalation entities.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Query Result Set Count", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description":"Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description":"Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description":"Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description":"Additional, exception details, for example, a stack trace."
            }
         }
      ],
      "count" : {"type": "integer"}
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "federationResult":
      [
         {  "systemID": {"type": "string",
               "description": "ID of the individual system the request was sent to."
            },
            "statusCode": {"type": "integer",
               "description": "HTTP Status Code returned from this system."
            },
            "errorNumber": {"type": "string", "optional": true,
               "description": "Message ID of the exception."
            },
            "errorMessage": {"type": "string", "optional": true,
               "description": "Message text of the exception."
            },
            "errorMessageParameters": {"type": ["string"], "optional": true,
               "description": "Message text parameters of the exception."
            },
            "programmersDetails": {"type": "object", "optional": true,
               "description": "Additional, exception details, for example, a stack trace."
            },
            "status": {"type": "string", "optional": true,
               "description": "Status of the request."
            },
            "exceptionType": {"type": "string", "optional": true,
               "description": "Type of the exception."
            }      
         }
      ], 
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description": "Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description": "Additional, exception details, for example, a stack trace."
      },
      "status": {"type": "string", "optional": true,
         "description": "Status of the request."
      },
      "exceptionType": {"type": "string", "optional": true,
         "description": "Type of the exception."
      }      
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion. The requested data is returned.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The query does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.
503 Service Unavailable	The federated request could not be delivered to individual federation targets.
504 Gateway Timeout	The federated response has partial content because of missing individual responses.

Available since

7.5.1

Parent topic: Escalation Query Entity List Count Resource