UpdateWorkItemRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateWorkItemRequest",
  "title": "UpdateWorkItemRequest",
  "type": "object",
  "description": "Payload to update a work item's status, result, or data",
  "required": [
    "id",
    "queueId",
    "version"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier of the work item to update"
    },
    "queueId": {
      "type": "integer",
      "format": "int64",
      "description": "ID of the queue containing the work item"
    },
    "version": {
      "type": "integer",
      "description": "Current optimistic locking version number (must match server value)"
    },
    "status": {
      "type": "string",
      "description": "New processing status for the work item",
      "enum": [
        "IN_PROGRESS",
        "FAILED",
        "COMPLETE",
        "DEFERRED"
      ]
    },
    "result": {
      "type": "string",
      "description": "Processing result to record on the work item",
      "enum": [
        "SUCCESS",
        "FAILURE"
      ]
    },
    "json": {
      "type": "object",
      "description": "Updated data payload for the work item",
      "additionalProperties": true
    }
  }
}