Class TasklistApiClient

The high-level client for the Tasklist REST API

Example

Index

Constructors

constructor

Methods

assignTask completeTask getForm getTask getVariable getVariables searchTasks unassignTask

Constructors

constructor

new TasklistApiClient(
    options?: {
        config?: DeepPartial<
            {
                CAMUNDA_AUTH_STRATEGY: | "BASIC"
                | "OAUTH"
                | "BEARER"
                | "COOKIE"
                | "NONE";
                CAMUNDA_BASIC_AUTH_PASSWORD: undefined
                | string;
                CAMUNDA_BASIC_AUTH_USERNAME: undefined | string;
                CAMUNDA_CONSOLE_BASE_URL: undefined | string;
                CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
                CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
                CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
                CAMUNDA_COOKIE_AUTH_PASSWORD: string;
                CAMUNDA_COOKIE_AUTH_URL: string;
                CAMUNDA_COOKIE_AUTH_USERNAME: string;
                CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
                CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
                CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
                CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
                CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
                CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
                CAMUNDA_LOG_LEVEL:
                    | "none"
                    | "error"
                    | "http"
                    | "warn"
                    | "info"
                    | "verbose"
                    | "debug"
                    | "silly";
                CAMUNDA_MODELER_BASE_URL: string;
                CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined
                | string;
                CAMUNDA_OAUTH_DISABLED: boolean;
                CAMUNDA_OAUTH_TOKEN: undefined | string;
                CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
                CAMUNDA_OAUTH_URL: undefined | string;
                CAMUNDA_OPERATE_BASE_URL: undefined | string;
                CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
                CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
                CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
                CAMUNDA_SECURE_CONNECTION: undefined | boolean;
                CAMUNDA_SUPPORT_LOG_ENABLED: boolean;
                CAMUNDA_SUPPORT_LOG_FILE_PATH: undefined | string;
                CAMUNDA_TASKLIST_BASE_URL: undefined | string;
                CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
                CAMUNDA_TENANT_ID: undefined | string;
                CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
                CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
                CAMUNDA_TOKEN_SCOPE: undefined | string;
                CAMUNDA_ZEEBE_OAUTH_AUDIENCE: undefined | string;
                ZEEBE_ADDRESS: undefined | string;
                ZEEBE_CLIENT_ID: undefined | string;
                ZEEBE_CLIENT_SECRET: undefined | string;
                ZEEBE_GRPC_ADDRESS: string;
                ZEEBE_REST_ADDRESS: string;
                ZEEBE_TOKEN_AUDIENCE: string;
                zeebeGrpcSettings: {
                    GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                    GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                    GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                    GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | 1000;
                    GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                    GRPC_KEEPALIVE_TIME_MS: number;
                    GRPC_KEEPALIVE_TIMEOUT_MS: number;
                    GRPC_MAX_RECONNECT_BACKOFF_MS: string | 10000;
                    GRPC_MIN_RECONNECT_BACKOFF_MS: string | 5000;
                    ZEEBE_CLIENT_LOG_LEVEL: "NONE" | "DEBUG" | "INFO" | "ERROR";
                    ZEEBE_CLIENT_LOG_TYPE: "JSON" | "SIMPLE";
                    ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                    ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                    ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                    ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                    ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                    ZEEBE_GRPC_CLIENT_RETRY: boolean;
                    ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                    ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
                    ZEEBE_INSECURE_CONNECTION: undefined | boolean;
                };
            },
        >;
        oAuthProvider?: IHeadersProvider<AuthHeader>;
    },
): TasklistApiClient
Tasklist API Client. All constructor parameters for configuration are optional. If no configuration is provided, the SDK will use environment variables to configure itself. See CamundaSDKConfiguration for the complete list of configuration parameters. Values can be passed in explicitly in code, or set via environment variables (recommended: separate configuration and application logic). Explicitly set values will override environment variables, which are merged into the configuration.
Parameters
- Optionaloptions: {
      config?: DeepPartial<
          {
              CAMUNDA_AUTH_STRATEGY: | "BASIC"
              | "OAUTH"
              | "BEARER"
              | "COOKIE"
              | "NONE";
              CAMUNDA_BASIC_AUTH_PASSWORD: undefined
              | string;
              CAMUNDA_BASIC_AUTH_USERNAME: undefined | string;
              CAMUNDA_CONSOLE_BASE_URL: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_ID: undefined | string;
              CAMUNDA_CONSOLE_CLIENT_SECRET: undefined | string;
              CAMUNDA_CONSOLE_OAUTH_AUDIENCE: string;
              CAMUNDA_COOKIE_AUTH_PASSWORD: string;
              CAMUNDA_COOKIE_AUTH_URL: string;
              CAMUNDA_COOKIE_AUTH_USERNAME: string;
              CAMUNDA_CUSTOM_CERT_CHAIN_PATH: undefined | string;
              CAMUNDA_CUSTOM_PRIVATE_KEY_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_PATH: undefined | string;
              CAMUNDA_CUSTOM_ROOT_CERT_STRING: undefined | string;
              CAMUNDA_CUSTOM_USER_AGENT_STRING: undefined | string;
              CAMUNDA_JOB_WORKER_MAX_BACKOFF_MS: number;
              CAMUNDA_LOG_LEVEL:
                  | "none"
                  | "error"
                  | "http"
                  | "warn"
                  | "info"
                  | "verbose"
                  | "debug"
                  | "silly";
              CAMUNDA_MODELER_BASE_URL: string;
              CAMUNDA_MODELER_OAUTH_AUDIENCE: undefined
              | string;
              CAMUNDA_OAUTH_DISABLED: boolean;
              CAMUNDA_OAUTH_TOKEN: undefined | string;
              CAMUNDA_OAUTH_TOKEN_REFRESH_THRESHOLD_MS: number;
              CAMUNDA_OAUTH_URL: undefined | string;
              CAMUNDA_OPERATE_BASE_URL: undefined | string;
              CAMUNDA_OPERATE_OAUTH_AUDIENCE: string;
              CAMUNDA_OPTIMIZE_BASE_URL: undefined | string;
              CAMUNDA_OPTIMIZE_OAUTH_AUDIENCE: string;
              CAMUNDA_SECURE_CONNECTION: undefined | boolean;
              CAMUNDA_SUPPORT_LOG_ENABLED: boolean;
              CAMUNDA_SUPPORT_LOG_FILE_PATH: undefined | string;
              CAMUNDA_TASKLIST_BASE_URL: undefined | string;
              CAMUNDA_TASKLIST_OAUTH_AUDIENCE: string;
              CAMUNDA_TENANT_ID: undefined | string;
              CAMUNDA_TOKEN_CACHE_DIR: undefined | string;
              CAMUNDA_TOKEN_DISK_CACHE_DISABLE: boolean;
              CAMUNDA_TOKEN_SCOPE: undefined | string;
              CAMUNDA_ZEEBE_OAUTH_AUDIENCE: undefined | string;
              ZEEBE_ADDRESS: undefined | string;
              ZEEBE_CLIENT_ID: undefined | string;
              ZEEBE_CLIENT_SECRET: undefined | string;
              ZEEBE_GRPC_ADDRESS: string;
              ZEEBE_REST_ADDRESS: string;
              ZEEBE_TOKEN_AUDIENCE: string;
              zeebeGrpcSettings: {
                  GRPC_HTTP2_MAX_PINGS_WITHOUT_DATA: number;
                  GRPC_HTTP2_MIN_PING_INTERVAL_WITHOUT_DATA_MS: number;
                  GRPC_HTTP2_MIN_TIME_BETWEEN_PINGS_MS: number;
                  GRPC_INITIAL_RECONNECT_BACKOFF_MS: string | 1000;
                  GRPC_KEEPALIVE_PERMIT_WITHOUT_CALLS: number;
                  GRPC_KEEPALIVE_TIME_MS: number;
                  GRPC_KEEPALIVE_TIMEOUT_MS: number;
                  GRPC_MAX_RECONNECT_BACKOFF_MS: string | 10000;
                  GRPC_MIN_RECONNECT_BACKOFF_MS: string | 5000;
                  ZEEBE_CLIENT_LOG_LEVEL: "NONE" | "DEBUG" | "INFO" | "ERROR";
                  ZEEBE_CLIENT_LOG_TYPE: "JSON" | "SIMPLE";
                  ZEEBE_GRPC_CLIENT_CONNECTION_TOLERANCE_MS: number;
                  ZEEBE_GRPC_CLIENT_EAGER_CONNECT: boolean;
                  ZEEBE_GRPC_CLIENT_INITIAL_CONNECTION_TOLERANCE_MS: undefined | number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRIES: number;
                  ZEEBE_GRPC_CLIENT_MAX_RETRY_TIMEOUT_SECONDS: number;
                  ZEEBE_GRPC_CLIENT_RETRY: boolean;
                  ZEEBE_GRPC_WORKER_LONGPOLL_SECONDS: number;
                  ZEEBE_GRPC_WORKER_POLL_INTERVAL_MS: number;
                  ZEEBE_INSECURE_CONNECTION: undefined | boolean;
              };
          },
      >;
      oAuthProvider?: IHeadersProvider<AuthHeader>;
  }
Returns TasklistApiClient
Example
```
const tasklist = new TasklistApiClient()
const tasks = await tasklist.getTasks({ state: TaskState.CREATED })
```
- Defined in src/tasklist/lib/TasklistApiClient.ts:64

Methods

assignTask

assignTask(
    __namedParameters: {
        allowOverrideAssignment?: boolean;
        assignee?: string;
        taskId: string;
    },
): Promise<TaskResponse>
Assign a task with taskId to assignee or the active user.
Parameters
- __namedParameters: { allowOverrideAssignment?: boolean; assignee?: string; taskId: string }
Returns Promise<TaskResponse>
Throws
Throws
Status 400 - An error is returned when the task is not active (not in the CREATED state). Status 400 - An error is returned when task was already assigned, except the case when JWT authentication token used and allowOverrideAssignment = true. Status 403 - An error is returned when user doesn't have the permission to assign another user to this task. Status 404 - An error is returned when the task with the taskId is not found.
- Defined in src/tasklist/lib/TasklistApiClient.ts:261

completeTask

completeTask(taskId: string, variables?: JSONDoc): Promise<TaskResponse>
Complete a task with taskId and optional variables
Parameters
- taskId: string
- Optionalvariables: JSONDoc
Returns Promise<TaskResponse>
Throws
Throws
Status 400 An error is returned when the task is not active (not in the CREATED state).

Throws
Status 400 An error is returned if the task was not claimed (assigned) before.

Throws
Status 400 An error is returned if the task is not assigned to the current user.

Throws
Status 403 User has no permission to access the task (Self-managed only).

Throws
Status 404 An error is returned when the task with the taskId is not found.
- Defined in src/tasklist/lib/TasklistApiClient.ts:293

getForm

getForm(
    formId: string,
    processDefinitionKey: string,
    version?: string | number,
): Promise<Form>
Get the form details by form id and processDefinitionKey.
Parameters
- formId: string
- processDefinitionKey: string
- Optionalversion: string | number
Returns Promise<Form>
Throws
- Defined in src/tasklist/lib/TasklistApiClient.ts:194

getTask

getTask(taskId: string): Promise<TaskResponse>
Return a task by id, or throw if not found.
Parameters
- taskId: string
Returns Promise<TaskResponse>
Throws
Will throw if no task of the given taskId exists
- Defined in src/tasklist/lib/TasklistApiClient.ts:180

getVariable

getVariable(variableId: string): Promise<Tasklist.TasklistDto.Variable>
https://docs.camunda.io/docs/apis-clients/tasklist-api/queries/variable/
Parameters
- variableId: string
Returns Promise<Tasklist.TasklistDto.Variable>
Throws
Throws 404 if no variable of the id is found
- Defined in src/tasklist/lib/TasklistApiClient.ts:243

getVariables

getVariables(
    __namedParameters: {
        includeVariables?: { alwaysReturnFullValue: boolean; name: string }[];
        taskId: string;
        variableNames?: string[];
    },
): Promise<VariableSearchResponse[]>
This method returns a list of task variables for the specified taskId and variableNames. If the variableNames parameter is empty, all variables associated with the task will be returned.
Parameters
- __namedParameters: {
      includeVariables?: { alwaysReturnFullValue: boolean; name: string }[];
      taskId: string;
      variableNames?: string[];
  }
Returns Promise<VariableSearchResponse[]>
Throws
- Defined in src/tasklist/lib/TasklistApiClient.ts:217

searchTasks

searchTasks(
    query:
        | TaskSearchAfterRequest
        | Partial<TaskSearchRequestBase>
        | TaskSearchAfterOrEqualRequest
        | TaskSearchBeforeRequest
        | TaskSearchBeforeOrEqualRequest,
): Promise<TaskSearchResponse[]>
Query Tasklist for a list of tasks. See the API documentation.
Parameters
- query:
      | TaskSearchAfterRequest
      | Partial<TaskSearchRequestBase>
      | TaskSearchAfterOrEqualRequest
      | TaskSearchBeforeRequest
      | TaskSearchBeforeOrEqualRequest
Returns Promise<TaskSearchResponse[]>
Throws
Status 400 - An error is returned when more than one search parameters among [searchAfter, searchAfterOrEqual, searchBefore, searchBeforeOrEqual] are present in request

Throws
Example
```
const tasklist = new TasklistApiClient()

async function getTasks() {
  const res = await tasklist.searchTasks({
    state: TaskState.CREATED
  })
  console.log(res ? 'Nothing' : JSON.stringify(res, null, 2))
  return res
}
```
- Defined in src/tasklist/lib/TasklistApiClient.ts:153

unassignTask

unassignTask(taskId: string): Promise<TaskResponse>
Unassign a task with taskId
Parameters
- taskId: string
Returns Promise<TaskResponse>
Throws
Status 400 An error is returned when the task is not active (not in the CREATED state).

Throws
Status 400 An error is returned if the task was not claimed (assigned) before.

Throws
Status 404 An error is returned when the task with the taskId is not found.

Throws
- Defined in src/tasklist/lib/TasklistApiClient.ts:317

Class TasklistApiClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TasklistApiClient

Example

Methods

assignTask

Parameters

Returns Promise<TaskResponse>

Throws

Throws

completeTask

Parameters

Returns Promise<TaskResponse>

Throws

Throws

Throws

Throws

Throws

Throws

getForm

Parameters

Returns Promise<Form>

Throws

getTask

Parameters

Returns Promise<TaskResponse>

Throws

getVariable

Parameters

Returns Promise<Tasklist.TasklistDto.Variable>

Throws

getVariables

Parameters

Returns Promise<VariableSearchResponse[]>

Throws

searchTasks

Parameters

Returns Promise<TaskSearchResponse[]>

Throws

Throws

Example

unassignTask

Parameters

Returns Promise<TaskResponse>

Throws

Throws

Throws

Throws

Settings

On This Page