Operation

Track the progress and result of an asynchronous command.
View as Markdown

An Operation represents a command accepted for asynchronous processing. Use its operation_uuid to correlate the lifecycle webhooks triggered by that command. See Awaiting asynchronous operations for a complete correlation pattern.

status: in_progress means command processing continues asynchronously and its result arrives through lifecycle events. status: completed is used when an idempotent terminal command was already satisfied without further processing. status: cancelling means a cancellation request was accepted while the original command moves toward its terminal lifecycle event.

Resource representation

The Operation resource
1{
2 "operation_uuid": "string",
3 "status": "in_progress"
4}

Properties

operation_uuidstringRequiredformat: "uuid"
statusenumRequired
Allowed values: