Skip to main content
Version: 8.6

Complete a task

PATCH 
/v1/tasks/:taskId/complete

Complete a task with taskId and optional variables. Returns the task.

Request​

Path Parameters

    taskId stringrequired

    The ID of the task.

Body

    variables object[]

    Variables to update or add to task during the task completion

  • Array [
    • name string

    The name of the variable.

    value string

    The value of the variable. When specifying the variable value, it's crucial to maintain consistency with JSON values (serialization for the complex objects such as list) and ensure that strings remain appropriately formatted.

  • ]

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]

    priority integer

    Possible values: [0,100]

    Default value: 50

    The priority of a user task. The higher the value the higher the priority. Applicable only for Zeebe user tasks.

Loading...