GET /rest/bpm/federated/htm/v1/escalations/query/{query}[?domain={string}|systemID={string}][&selectedAttributes={string}][&interactionFilter={string}][&queryFilter={string}][&processAppName={string}][&sortAttributes={string}][&offset={integer}][&size={integer}][&admin={boolean}]| 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. |
| Name | Value Type | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| selectedAttributes | string | Comma-separated list of attributes, in uppercase letters, which specifies the attributes that are retrieved by the query. If no selected attributes are specified, all the attributes that are defined on the query are returned and no work item information is returned.
|
||||||||
| interactionFilter | string | Name of a predefined user interaction.
|
||||||||
| 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.
|
||||||||
| sortAttributes | string | Comma-separated list of sort criteria applied to the list of returned process instance entities. Each list entry is in the form attribute [ASC|DESC] where ascending is the default.
|
||||||||
| offset | integer | Specifies the number of entities to be skipped in the result set. This parameter is only allowed if the parameter systemID is also specified, and rejected in other cases.
|
||||||||
| size | integer | Limits the number of entities returned. The threshold setting might not be accurate.
|
||||||||
| admin | boolean | Administration authorization option specifying whether the request is performed by an administrator.
|
None
The default content-type is application/json.
{ "description": "Query Result Set",
"type": "object",
"properties":
{ "identifier" : {"type": "string",
"description": "Name of query result set attribute identifying an entity."
},
"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."
}
}
],
"query": {"type": "string",
"description": "Name of the query that is associated with this query result set."
},
"entityTypeName": {"type": "string",
"description": "Type of entities that are returned as the result of the query."
},
"attributeInfo":
[ { "name": {"type": "string",
"description": "Attribute name."
},
"type": {"type": "string",
"description": "Attribute type."
},
"isArray": {"type": "boolean",
"description": "Specifies whether the attribute has an array of values."
},
"content": {"type": "string",
"description": "A string that identifies attributes with a well-known value range."
},
"sourceAttribute": {"type": "string",
"description": "The related query table and attribute which provides this attributes' information."
},
"sourceQueryTableIdentifier": {"type": "string", "optional": true,
"description": "The ID of the source attribute's table, as defined in the query table definition."
}
}
],
"items":
[ { "type": "object",
"description": "Entities contained in this query result set; the system ID of the system hosting the entity, and a list of attribute names and values, as selected by selectedAttributes, plus the entities' key (using its source attribute name)."
}
]
}
}
The default content-type is application/json.
{ "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."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Successful completion. The requested data is returned. Note that the list might be empty.
|
| 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. |
7.5.1
Parent topic: Escalation Query Entity List Resource