GET /api-web/api/bpm/tasks

As of Version

product version 2020 Autumn | component version

Request Method GET

Response Format JSON

Description

Retrieves a list of tasks corresponding to the businessKey specified as query parameter.

The following query parameters can optionally be added to the request URL.

Parameter	Type	Description
`businessKey`	string	Only return process instances with the given `businessKey`.
`includeProcessVariables`	boolean	Include process variables in the result.
`page`	integer($int32)	Results page you want to retrieve (0…N). Default is `0` which means the first page.
`processInstanceId`	string	Only return tasks which are part of the process instance with the given ID.
`size`	integer($int32)	Number of objects per page.
`sort`	string	Sorting of results either ascending (`asc`) or descending (`desc`). Default sort order is ascending.
`briefRepresentation` (as of 2022 Winter)	boolean	Decides whether to exclude specific properties from the retrieved task instances in order to safe processing time.

Response HTTP status codes:

HTTP Status Code	Meaning
`200`	The request was successful and the process instances are returned.
`400`	A parameter was passed in the wrong format. The status message contains additional information.

Request Example

https://<host>/api-web/api/bpm/tasks?active=true&businessKey=examplekey&includeProcessVariables=true

no request body

Response Example

200 OK

response body

{
  "data": [],
  "total": 0,
  "start": 0,
  "sort": "id",
  "order": "asc",
  "size": 0
}