GET /bpm-engine/api/tasks

As of Version

product version 2021 Autumn | component version

Request Method GET

Response Format JSON

Description

Retrieves a list of tasks of the currently active user that are matching the conditions defined in various query parameters.

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

Parameter	Type	Description
`createdAfter`	string	Only return tasks which have been created after the given date.
`createdBefore`	string	Only return tasks which have been created before the given date.
`createdOn`	string	Only return tasks which have been created on the given date.
`description`	string	Only return tasks with the given description.
`dueAfter`	string	Only return tasks which are due after the given date.
`dueBefore`	string	Only return tasks which are due before the given date.
`dueOn`	string	Only return tasks which are due on the given date.
`filter` (up to 2022 Winter)	string	Allows to filter the result. By default, all tasks that are assigned to the current user, have been claimed by the current user or are waiting to be claimed by the current user (candidate user or groups) will be returned.
`isAssigned` (as of 2023 Spring)	boolean	If `isAssigned=true`, the endpoint retrieves only tasks that are assigned to the currently logged-in user. If `isAssigend=false`, the endpoint retrieves only tasks without an assignee for which the currently logged-in user is a candidate user. If `isAssigned` is not specified in the request URL, the endpoint retrieves tasks that are assigned to the currently logged-in user as well as tasks without an assignee for which the currently logged-in user is a candidate user.
`includeProcessVariables`	boolean	Include process variables in the result.
`name`	string	Only return process instances with the given name.
`nameLike`	string	Specify a string that has to match the `name` and that can contain `%` characters as placeholders for an arbitrary number of unknown characters.
`page`	integer($int32)	Results page you want to retrieve (0…N). Default is `0` which means the first page.
`processDefinitionId`	string	Only return process instances with the given process definition ID.
`processDefinitionKey`	string	Only return process instances with the given process definition key.
`processDefinitionKeyLike`	string	Specify a string that has to match the `processDefinitionKey` and that can contain `%` characters as placeholders for an arbitrary number of unknown characters. Only return tasks which are part of a process instance which has a process definition with a key matching the given value.
`processDefinitionName`	string	Only return tasks which are part of a process instance which has a process definition with the given name.
`processDefinitionNameLike`	string	Specify a string that has to match the `processDefinitionName` and that can contain `%` characters as placeholders for an arbitrary number of unknown characters. Only return tasks which are part of a process instance which has a process definition with a name matching the given value.
`processInstanceBusinessKey`	string	Only return tasks which are part of the process instance with the given business key.
`processInstanceBusinessKeyLike`	string	Specify a string that has to match the `processInstanceBusinessKey` and that can contain `%` characters as placeholders for an arbitrary number of unknown characters. Only return tasks which are part of the process instance which has a business key matching the given value.
`processInstanceId`	string	Only return tasks which are part of the process instance with the given ID.
`processInstanceIdWithChildren`	string	Only return tasks which are part of the process instance and its children with the given ID.
`scopeDefinitionId`	string	Only return tasks with the given `scopeDefinitionId`.
`scopeId`	string	Only return tasks with the given `scopeId`.
`scopeType`	string	Only return tasks with the given `scopeType`.
`size`	integer($int32)	Number of objects per page.
`sort`	string	Sorting of results either ascending (`asc`) or descending (`desc`). Default sort order is ascending.
`withoutDueDate`	boolean	Only return tasks which do not have a due date. The property is ignored if the value is `false`.
`isCompleted`	boolean	As of 2023 Autumn: If `true`, only completed tasks are returned. If `false`, only running tasks are returned. If not specified, both completed and running tasks are returned.
`visibleTo`	string	As of 2023 Autumn: Only return tasks visible to this user.

Meaning of HTTP status codes:

HTTP Status Code	Description
200	The request was successful and the tasks are returned.
401	The calling user is not authorized.
404	A parameter was passed in the wrong format. The status message contains additional information.

Request Header Content-Type: application/json

Request Example

https://<host>/bpm-engine/api/tasks?page=0&size=1

Response Example

{
  "objects": [
    {
      "id": "187",
      "name": "1st_task",
      "description": "In this case, you have to do several things as they are:\n1. subtask\n2. subtask",
      "assignee": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "owner": aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa5,
      "createTime": "2021-11-01T12:28:46.388Z",
      "endTime": "2023-12-02T13:39:57.499Z",
      "claimTime": "2021-11-01T13:29:47.389Z",
      "processDefinitionId": "twosteptest_proc:4:8dc694a2-10b1-11ec-99ef-027ea5eeae02",
      "processInstanceId": "00000000-0000-0000-0000-000000000000",
      "parentTaskId": null,
      "formKey": "twosteptest_proc:1st_task",
      "taskDefinitionKey": "sid-4CAF2A19-B303-46C6-A7C0-2F506F1613D4",
      "delegationState": "pending",
      "suspended": true,
      "variables": [
        {
          "name": "whatabout",
          "type": "string",
          "value": "testValue",
          "scope": "global"
        },
        {
          "name": "initiator",
          "type": "string",
          "value": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaa5",
          "scope": "global"
        }
      ]
    }
  ],
  "numItems": 1,
  "totalNumItems": 1,
  "hasMoreItems": false
}