获取列表

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

taskId

string

Filter by task id.

taskParentTaskId

string

Filter by parent task id.

processInstanceId

string

Filter by process instance id.

rootProcessInstanceId

string

Filter by root process instance id.

processInstanceBusinessKey

string

Filter by process instance business key.

processInstanceBusinessKeyIn

string

Filter by process instances with one of the give business keys. The keys need to be in a comma-separated list.

processInstanceBusinessKeyLike

string

Filter by process instance business key that has the parameter value as a substring.

executionId

string

Filter by the id of the execution that executed the task.

processDefinitionId

string

Filter by process definition id.

processDefinitionKey

string

Restrict to tasks that belong to a process definition with the given key.

processDefinitionName

string

Restrict to tasks that belong to a process definition with the given name.

caseInstanceId

string

Filter by case instance id.

caseExecutionId

string

Filter by the id of the case execution that executed the task.

caseDefinitionId

string

Filter by case definition id.

caseDefinitionKey

string

Restrict to tasks that belong to a case definition with the given key.

caseDefinitionName

string

Restrict to tasks that belong to a case definition with the given name.

activityInstanceIdIn

string

Only include tasks which belong to one of the passed comma-separated activity instance ids.

taskName

string

Restrict to tasks that have the given name.

taskNameLike

string

Restrict to tasks that have a name with the given parameter value as substring.

taskDescription

string

Restrict to tasks that have the given description.

taskDescriptionLike

string

Restrict to tasks that have a description that has the parameter value as a substring.

taskDefinitionKey

string

Restrict to tasks that have the given key.

taskDefinitionKeyIn

string

Restrict to tasks that have one of the passed comma-separated task definition keys.

taskDeleteReason

string

Restrict to tasks that have the given delete reason.

taskDeleteReasonLike

string

Restrict to tasks that have a delete reason that has the parameter value as a substring.

taskAssignee

string

Restrict to tasks that the given user is assigned to.

taskAssigneeLike

string

Restrict to tasks that are assigned to users with the parameter value as a substring.

taskOwner

string

Restrict to tasks that the given user owns.

taskOwnerLike

string

Restrict to tasks that are owned by users with the parameter value as a substring.

taskPriority

integer

Restrict to tasks that have the given priority.

assigned

boolean

If set to true, restricts the query to all tasks that are assigned.

unassigned

boolean

If set to true, restricts the query to all tasks that are unassigned.

finished

boolean

Only include finished tasks. Value may only be true, as false is the default behavior.

unfinished

boolean

Only include unfinished tasks. Value may only be true, as false is the default behavior.

processFinished

boolean

Only include tasks of finished processes. Value may only be true, as false is the default behavior.

processUnfinished

boolean

Only include tasks of unfinished processes. Value may only be true, as false is the default behavior.

taskDueDate

string<date-time>

Restrict to tasks that are due on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskDueDateBefore

string<date-time>

Restrict to tasks that are due before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskDueDateAfter

string<date-time>

Restrict to tasks that are due after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

withoutTaskDueDate

boolean

Only include tasks which have no due date. Value may only be true, as false is the default behavior.

taskFollowUpDate

string<date-time>

Restrict to tasks that have a followUp date on the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskFollowUpDateBefore

string<date-time>

Restrict to tasks that have a followUp date before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

taskFollowUpDateAfter

string<date-time>

Restrict to tasks that have a followUp date after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedBefore

string<date-time>

Restrict to tasks that were started before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

startedAfter

string<date-time>

Restrict to tasks that were started after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedBefore

string<date-time>

Restrict to tasks that were finished before the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

finishedAfter

string<date-time>

Restrict to tasks that were finished after the given date. By default, the date must have the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g., 2013-01-23T14:42:45.000+0200.

tenantIdIn

string

Filter by a comma-separated list of tenant ids. A task instance must have one of the given tenant ids.

withoutTenantId

boolean

Only include historic task instances that belong to no tenant. Value may only be true, as false is the default behavior.

taskVariables

string

Only include tasks that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

A valid parameter value has the form key_operator_value. key is the variable name, operator is the comparison operator to be used and value the variable value. Note: Values are always treated as String objects on server side.

Valid operator values are:

eq - equal to;
neq - not equal to;
gt - greater than;
gteq - greater than or equal to;
lt - lower than;
lteq - lower than or equal to;
like.

key and value may not contain underscore or comma characters.

processVariables

string

Only include tasks that belong to process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows:

Valid operator values are:

eq - equal to;
neq - not equal to;
gt - greater than;
gteq - greater than or equal to;
lt - lower than;
lteq - lower than or equal to;
like;
notLike.

key and value may not contain underscore or comma characters.

variableNamesIgnoreCase

boolean

Match the variable name provided in taskVariables and processVariables case- insensitively. If set to true variableName and variablename are treated as equal.

variableValuesIgnoreCase

boolean

Match the variable value provided in taskVariables and processVariables case- insensitively. If set to true variableValue and variablevalue are treated as equal.

taskInvolvedUser

string

Restrict to tasks with a historic identity link to the given user.

taskInvolvedGroup

string

Restrict to tasks with a historic identity link to the given group.

taskHadCandidateUser

string

Restrict to tasks with a historic identity link to the given candidate user.

taskHadCandidateGroup

string

Restrict to tasks with a historic identity link to the given candidate group.

withCandidateGroups

boolean

Only include tasks which have a candidate group. Value may only be true, as false is the default behavior.

withoutCandidateGroups

boolean

Only include tasks which have no candidate group. Value may only be true, as false is the default behavior.

sortBy

enum<string>

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

Available options:

taskId,

activityInstanceId,

processDefinitionId,

processInstanceId,

executionId,

duration,

endTime,

startTime,

taskName,

taskDescription,

assignee,

owner,

dueDate,

followUpDate,

deleteReason,

taskDefinitionKey,

priority,

caseDefinitionId,

caseInstanceId,

caseExecutionId,

tenantId

sortOrder

enum<string>

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

Available options:

asc,

desc

firstResult

integer

Pagination of results. Specifies the index of the first result to return.

maxResults

integer

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

Response

Request successful.

string | null

The task id.

processDefinitionKey

string | null

The key of the process definition the task belongs to.

processDefinitionId

string | null

The id of the process definition the task belongs to.

processInstanceId

string | null

The id of the process instance the task belongs to.

executionId

string | null

The id of the execution the task belongs to.

caseDefinitionKey

string | null

The key of the case definition the task belongs to.

caseDefinitionId

string | null

The id of the case definition the task belongs to.

caseInstanceId

string | null

The id of the case instance the task belongs to.

caseExecutionId

string | null

The id of the case execution the task belongs to.

activityInstanceId

string | null

The id of the activity that this object is an instance of.

name

string | null

The task name.

description

string | null

The task's description.

deleteReason

string | null

The task's delete reason.

owner

string | null

The owner's id.

assignee

string | null

The assignee's id.

startTime

string<date-time> | null

The time the task was started. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

endTime

string<date-time> | null

The time the task ended. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

duration

integer | null

The time the task took to finish (in milliseconds).

taskDefinitionKey

string | null

The task's key.

priority

integer | null

The task's priority.

due

string<date-time> | null

The task's due date. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

parentTaskId

string | null

The id of the parent task, if this task is a subtask.

followUp

string<date-time> | null

The follow-up date for the task. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

tenantId

string | null

The tenant id of the task instance.

removalTime

string<date-time> | null

The time after which the task should be removed by the History Cleanup job. Default format yyyy-MM-dd'T'HH:mm:ss.SSSZ.

rootProcessInstanceId

string | null

The process instance id of the root process instance that initiated the process containing this task.

taskState

string | null

The task's state.

REST API

Javadoc

Authorizations

Query Parameters

Response