Interface TaskSearchBeforeOrEqualRequest

interface TaskSearchBeforeOrEqualRequest {
    assigned?: boolean;
    assignee?: string;
    assignees?: string[];
    candidateGroup?: string;
    candidateGroups?: string[];
    candidateUser?: string;
    candidateUsers?: string[];
    dueDate?: DateFilter;
    followUpDate?: DateFilter;
    implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK";
    includeVariables?: IncludeVariable[];
    pageSize?: number;
    processDefinitionKey?: string;
    processInstanceKey?: string;
    searchBeforeOrEqual: string[];
    sort?: TaskOrderBy[];
    state?: TaskState;
    taskDefinitionId?: string;
    taskVariables?: TaskByVariables[];
    tenantIds?: string[];
}

Hierarchy

Properties

assigned? assignee? assignees? candidateGroup? candidateGroups? candidateUser? candidateUsers? dueDate? followUpDate? implementation? includeVariables? pageSize? processDefinitionKey? processInstanceKey? searchBeforeOrEqual sort? state? taskDefinitionId? taskVariables? tenantIds?

Properties

Optional assigned

assigned?: boolean

Optional assignee

assignee?: string

Optional assignees

assignees?: string[]

Optional candidateGroup

candidateGroup?: string

Optional candidateGroups

candidateGroups?: string[]

Optional candidateUser

candidateUser?: string

Optional candidateUsers

candidateUsers?: string[]

Optional dueDate

dueDate?: DateFilter

Optional followUpDate

followUpDate?: DateFilter

Optional implementation

implementation?: "JOB_WORKER" | "ZEEBE_USER_TASK"

Optional includeVariables

includeVariables?: IncludeVariable[]

An array used to specify a list of variable names that should be included in the response when querying tasks. This field allows users to selectively retrieve specific variables associated with the tasks returned in the search results.

Optional pageSize

pageSize?: number

Optional processDefinitionKey

processDefinitionKey?: string

Optional processInstanceKey

processInstanceKey?: string

searchBeforeOrEqual

searchBeforeOrEqual: string[]

Used to return a paginated result. Array of values that should be copied from sortValues of one of the tasks from the current search results page. It enables the API to return a page of tasks that directly precede or are equal to the task identified by the provided values, with respect to the sorting order.

Optional sort

sort?: TaskOrderBy[]

Optional state

state?: TaskState

Optional taskDefinitionId

taskDefinitionId?: string

Optional taskVariables

taskVariables?: TaskByVariables[]

An array of filter clauses specifying the variables to filter for. If defined, the query returns only tasks to which all clauses apply. However, it's important to note that this filtering mechanism is designed to work exclusively with truncated variables. This means variables of a larger size are not compatible with this filter, and attempts to use them may result in inaccurate or incomplete query results.

Optional tenantIds

tenantIds?: string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc