List Human Tasks

Used to retrieve a list of human tasks by filters. An example use of this API will be to compose an inbox view for a user.

note

The invoking user should be a task owner, an ADMIN, or an assignee to the tasks returned. When using application credentials, the application should be the owner of the task in the workflow definition.

Input Payload

Attribute	Description
state	The state of the human task which you want to retrieve - available options are PENDING, ASSIGNED, IN_PROGRESS, COMPLETED, and TIMED_OUT.
assignee	The assignee on the task.
assigneeType	The assignee type on the task - options are EXTERNAL_USER, EXTERNAL_GROUP, CONDUCTOR_USER, and CONDUCTOR_GROUP.
claimedBy	The id of the user who claimed the task - the format is assigneeType:<value> ex: EXTERNAL_GROUP:group-name.
taskName	The name of the task - this is also the UI template name of the task.
freeText	Additional criteria of a free text - this can include input/output values and other indexed fields.
includeInputOutput	Boolean to indicate if the inputs and outputs of the task should be included in the response.

API Endpoint

GET human/tasks

Client SDK Methods

Java

TODO: Coming soon to the SDKs

Golang

TODO: Coming soon to the SDKs

Python

TODO: Coming soon to the SDKs

CSharp

TODO: Coming soon to the SDKs

Javascript

HumanExecutor.getTasksByFilter(
    state: "PENDING" | "ASSIGNED" | "IN_PROGRESS" | "COMPLETED" | "TIMED_OUT",
    assignee?: string,
    assigneeType?:
      | "EXTERNAL_USER"
      | "EXTERNAL_GROUP"
      | "CONDUCTOR_USER"
      | "CONDUCTOR_GROUP",
    claimedBy?: string,
    taskName?: string,
    freeText?: string,
    includeInputOutput: boolean = false
  ): Promise<HumanTaskEntry[]>

Typescript

HumanExecutor.getTasksByFilter(
    state: "PENDING" | "ASSIGNED" | "IN_PROGRESS" | "COMPLETED" | "TIMED_OUT",
    assignee?: string,
    assigneeType?:
      | "EXTERNAL_USER"
      | "EXTERNAL_GROUP"
      | "CONDUCTOR_USER"
      | "CONDUCTOR_GROUP",
    claimedBy?: string,
    taskName?: string,
    freeText?: string,
    includeInputOutput: boolean = false
  ): Promise<HumanTaskEntry[]>

Clojure

TODO: Coming soon to the SDKs