Skip to main content
Version: 8.9 (unreleased)

Type Alias: SearchUserTasksData

type SearchUserTasksData = object;

Defined in: gen/types.gen.ts:16678

Properties

body?

optional body: SearchQueryRequest & object;

Defined in: gen/types.gen.ts:16682

User task search query request.

Type Declaration

filter?
optional filter: object;

User task filter request.

filter.assignee?
optional assignee: StringFilterProperty;

The assignee of the user task.

filter.candidateGroup?
optional candidateGroup: StringFilterProperty;

The candidate group for this user task.

filter.candidateUser?
optional candidateUser: StringFilterProperty;

The candidate user for this user task.

filter.completionDate?
optional completionDate: DateTimeFilterProperty;

The user task completion date.

filter.creationDate?
optional creationDate: DateTimeFilterProperty;

The user task creation date.

filter.dueDate?
optional dueDate: DateTimeFilterProperty;

The user task due date.

filter.elementId?
optional elementId: ElementId;

The element ID of the user task.

filter.elementInstanceKey?
optional elementInstanceKey: ElementInstanceKey;

The key of the element instance.

filter.followUpDate?
optional followUpDate: DateTimeFilterProperty;

The user task follow-up date.

filter.localVariables?
optional localVariables: VariableValueFilterProperty[];
filter.name?
optional name: StringFilterProperty;

The task name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found.

filter.priority?
optional priority: IntegerFilterProperty;

The priority of the user task.

filter.processDefinitionId?
optional processDefinitionId: ProcessDefinitionId;

The ID of the process definition.

filter.processDefinitionKey?
optional processDefinitionKey: ProcessDefinitionKey;

The key of the process definition.

filter.processInstanceKey?
optional processInstanceKey: ProcessInstanceKey;

The key of the process instance.

filter.processInstanceVariables?
optional processInstanceVariables: VariableValueFilterProperty[];
filter.state?
optional state: UserTaskStateFilterProperty;

The user task state.

filter.tags?
optional tags: TagSet;
filter.tenantId?
optional tenantId: StringFilterProperty;

Tenant ID of this user task.

filter.userTaskKey?
optional userTaskKey: UserTaskKey;

The key for this user task.

sort?
optional sort: object[];

Sort field criteria.


path?

optional path: never;

Defined in: gen/types.gen.ts:16771


query?

optional query: never;

Defined in: gen/types.gen.ts:16772


url

url: "/user-tasks/search";

Defined in: gen/types.gen.ts:16773