Complete a work item by submitting the operator response

Completes a work item by submitting the operator response.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

idstringRequiredformat: "uuid"
Work item UUID

Request

request body
finishStatestringOptional
Opaque finish state string emitted by the view component.
variablesobjectOptional

Flat key-value pairs representing the operator’s raw submission. Omitted for read-only task types.

Response

Work item completed successfully
idstringformat: "uuid"

Unique identifier (UUID) of the work item.

namestring

Human-readable name of the work item.

summarystring
Brief summary of the work item.
statusenum
Current status of the work item.
groupsobject
Access control groups.
appIdstring
Application identifier that is creating the work item.
resourceIdstring
Resource identifier for tracking across application boundaries. Combined with appId to enforce uniqueness constraint.
rootExecutionobject
Root execution metadata for the detail view header.
executionobject
Execution that invoked createWorkItem.
viewstring
Relative URL path to the UI view for this task.
variablesobject
Variables for the renderer.
metricsobject
Work item operational metrics.
createdAtstring
ISO 8601 creation timestamp.
isIncomingClaimCheckedboolean

Whether the incoming variables are stored as a claim check (large data).

updatedAtstring
ISO 8601 last updated timestamp.
descriptionstring
Optional detailed description of the work item.

Errors

500
Internal Server Error