Type Alias SearchUserTasksData

Type Declaration

• Optionalfilter?: {
      assignee?: StringFilterProperty;
      candidateGroup?: StringFilterProperty;
      candidateUser?: StringFilterProperty;
      completionDate?: DateTimeFilterProperty;
      creationDate?: DateTimeFilterProperty;
      dueDate?: DateTimeFilterProperty;
      elementId?: ElementId;
      elementInstanceKey?: ElementInstanceKey;
      followUpDate?: DateTimeFilterProperty;
      localVariables?: VariableValueFilterProperty[];
      name?: string;
      priority?: IntegerFilterProperty;
      processDefinitionId?: ProcessDefinitionId;
      processDefinitionKey?: ProcessDefinitionKey;
      processInstanceKey?: ProcessInstanceKey;
      processInstanceVariables?: VariableValueFilterProperty[];
      state?: UserTaskStateFilterProperty;
      tags?: TagSet;
      tenantId?: StringFilterProperty;
      userTaskKey?: UserTaskKey;
  }

  User task filter request.

  • Optionalassignee?: StringFilterProperty

    The assignee of the user task.

  • OptionalcandidateGroup?: StringFilterProperty

    The candidate group for this user task.

  • OptionalcandidateUser?: StringFilterProperty

    The candidate user for this user task.

  • OptionalcompletionDate?: DateTimeFilterProperty

    The user task completion date.

  • OptionalcreationDate?: DateTimeFilterProperty

    The user task creation date.

  • OptionaldueDate?: DateTimeFilterProperty

    The user task due date.

  • OptionalelementId?: ElementId

    The element ID of the user task.

  • OptionalelementInstanceKey?: ElementInstanceKey

    The key of the element instance.

  • OptionalfollowUpDate?: DateTimeFilterProperty

    The user task follow-up date.

  • OptionallocalVariables?: VariableValueFilterProperty[]

  • Optionalname?: string

    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.

  • Optionalpriority?: IntegerFilterProperty

    The priority of the user task.

  • OptionalprocessDefinitionId?: ProcessDefinitionId

    The ID of the process definition.

  • OptionalprocessDefinitionKey?: ProcessDefinitionKey

    The key of the process definition.

  • OptionalprocessInstanceKey?: ProcessInstanceKey

    The key of the process instance.

  • OptionalprocessInstanceVariables?: VariableValueFilterProperty[]

  • Optionalstate?: UserTaskStateFilterProperty

    The user task state.

  • Optionaltags?: TagSet

  • OptionaltenantId?: StringFilterProperty

    Tenant ID of this user task.

  • OptionaluserTaskKey?: UserTaskKey

    The key for this user task.

• Optionalsort?: {
      field:
          | "creationDate"
          | "completionDate"
          | "followUpDate"
          | "dueDate"
          | "priority"
          | "name";
      order?: SortOrderEnum;
  }[]

  Sort field criteria.