GET /rest/bpm/federated/bfm/v1/activities/query/{query}/count[?domain={string}|systemID={string}][&queryFilter={string}][&processAppName={string}][&everybody={boolean}][&individual={boolean}][&group={boolean}][&inherited={boolean}][&admin={boolean}][&onBehalfUser={string}]| 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| 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.
|
||||||
| everybody | boolean | Authorization option specifying that everybody work items (which is the staff verb "Everybody") are taken into account if instance-based authorization is enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
|
||||||
| individual | boolean | Authorization option specifying that individual work items, for example, the staff verb "Users", are considered if enabled on the query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
|
||||||
| group | boolean | Authorization option specifying that group work items, for example, the staff verb "Group", are taken into account if instance-based authorization is enabled on the query table and if enabled on the Human Task Container. This parameter has no default. If it is omitted then the settings of the query table definition apply.
|
||||||
| inherited | boolean | Authorization option specifying that inherited work items are considered, for instance, the administrator of a process instance might then see participating human task instances created for that process instance if it executes a query against that query table. This parameter has no default. If it is omitted then the settings of the query table definition apply.
|
||||||
| admin | boolean | Administration authorization option specifying whether the request is performed by an administrator.
|
||||||
| onBehalfUser | string | Administration authorization option specifying that the query is run under the authority of the specified user, and the objects in the query table are checked against the work items for this user if instance-based authorization is used. This parameter is only valid if the admin parameter has been specified with a value true. If admin is set true and this parameter is not used then the request runs as administrator.
|
None
The default content-type is application/json.
{ "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"}
}
}
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.
|
| 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: Activity Instance Query Entity List Count Resource