Skip to main content
Version: Next

Get user task (alpha)

GET 
/user-tasks/:userTaskKey

Get the user task by the user task key.

Note that this endpoint is an alpha feature and not enabled on Camunda clusters out of the box. The Camunda 8 API (REST) Overview page provides further details.

note

This endpoint is an alpha feature and may be subject to change in future releases.

Request​

Path Parameters

    userTaskKey int64required

    The user task key.

Responses​

The user task is successfully returned.

Schema
    userTaskKey int64

    The key for this user task.

    state string

    Possible values: [CREATED, COMPLETED, CANCELED, FAILED]

    The state of the user task.

    assignee string

    The assignee of the user task.

    elementId string

    The element ID of the user task.

    elementInstanceKey int64

    The key of the element instance.

    candidateGroups string[]

    The candidate groups for this user task.

    candidateUsers string[]

    The candidate users for this user task.

    processDefinitionId string

    The ID of the process definition.

    processDefinitionKey int64

    The key of the process definition.

    processInstanceKey int64

    The key of the process instance.

    formKey int64

    The key of the form.

    creationDate date-time

    The creation date of a user task.

    completionDate date-time

    The completion date of a user task.

    followUpDate date-time

    The follow date of a user task.

    dueDate date-time

    The due date of a user task.

    tenantId string

    Tenant ID of this user task.

    externalFormReference string

    The external form reference.

    processDefinitionVersion int32

    The version of the process definition.

    customHeaders object

    Custom headers for the user task.

    property name* string
    priority integer

    Possible values: <= 100

    Default value: 50

    The priority of a user task. The higher the value the higher the priority.

Loading...