Skip to main content
Version: Next

Assign a task

PATCH 
/v1/tasks/:taskId/assign

Assign a task with taskId to assignee or the active user. Returns the task.

Request​

Path Parameters

    taskId stringrequired

    The ID of the task.

Body

When using REST API with JWT authentication token following request body parameters may be used.

    assignee string

    When using a JWT token, the assignee parameter is NOT optional when called directly from the API. The system will not be able to detect the assignee from the JWT token, therefore the assignee parameter needs to be explicitly passed in this instance.

    allowOverrideAssignment boolean

    Default value: true

    When true the task that is already assigned may be assigned again. Otherwise the task must be first unassigned and only then assigned again.

Responses​

On success returned.

Schema
    id string

    The unique identifier of the task.

    name string

    The name of the task.

    taskDefinitionId string

    User Task ID from the BPMN definition.

    processName string

    The name of the process.

    creationDate string

    When was the task created (renamed equivalent of Task.creationTime field).

    completionDate string

    When was the task completed (renamed equivalent of Task.completionTime field).

    assignee string

    The username/id of who is assigned to the task.

    taskState string

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

    The state of the task.

    formKey string

    Reference to the task form.

    formId string

    Reference to the ID of a deployed form. If the form is not deployed, this property is null.

    formVersion int64

    Reference to the version of a deployed form. If the form is not deployed, this property is null.

    isFormEmbedded boolean

    Is the form embedded for this task? If there is no form, this property is null.

    processDefinitionKey string

    Reference to process definition (renamed equivalent of Task.processDefinitionId field).

    processInstanceKey string

    Reference to process instance id (renamed equivalent of Task.processInstanceId field).

    tenantId string

    The tenant ID associated with the task.

    dueDate date-time

    The due date for the task.

    followUpDate date-time

    The follow-up date for the task.

    candidateGroups string[]

    The candidate groups for the task.

    candidateUsers string[]

    The candidate users for the task.

    implementation string

    Possible values: [JOB_WORKER, ZEEBE_USER_TASK]

Loading...