workCenterService

Complete a work item by submitting the operator response

Completes a work item by submitting the operator response.

patch/work-center-service/work-items/{id}/complete

Request

  • Base URL: https://example.itential.io
  • URL: https://example.itential.io/work-center-service/work-items/{id}/complete
  • Auth: none declared

Path parameters

idstring uuid required

Work item UUID

Request body

finishStatestring

Opaque finish state string emitted by the view component.

variablesWorkCenterServiceWorkItemsIdCompletePatchRequestBodyContentApplicationJsonSchemaVariables

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

Response

Work item completed successfully

idstring uuid required

Unique identifier (UUID) of the work item.

namestring required

Human-readable name of the work item.

summarystring required

Brief summary of the work item.

descriptionstring

Optional detailed description of the work item.

status'pending' | 'completed' | 'canceled' required

Current status of the work item.

appIdstring required

Application identifier that is creating the work item.

resourceIdstring required

Resource identifier for tracking across application boundaries. Combined with appId to enforce uniqueness constraint.

viewstring required

Relative URL path to the UI view for this task.

createdAtstring required

ISO 8601 creation timestamp.

isIncomingClaimCheckedboolean required

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

updatedAtstring required

ISO 8601 last updated timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.