get operation details

GET https://api.suger.cloud/org/{orgId}/v2/operation/{operationId}

Get the details of a Temporal workflow operation by operation ID. Optionally include child workflow data.

Parameters

Name	In	Type	Required	Description
`orgId`	path	string	yes	Organization ID
`operationId`	path	string	yes	Temporal Workflow ID
`runId`	query	string	no	Temporal run ID of the workflow
`hasChildren`	query	boolean	no	Include data aggregated from all child workflows (1 level), default false

Content-Type: application/json · Schema: Operation

Operation fields:

Field	Type	Required	Description
`childCompleted`	integer	no
`childFailed`	integer	no	ChildFailed sums Failed + Terminated + TimedOut + Canceled.
`childOffsetToken`	string	no	Pagination token for the next page of ChildWorkflowOperations. Empty string means no more pages. Pass back as `childOffsetToken` query param.
`childTotal`	integer	no	Aggregate child counts from the visibility index. Populated alongside ChildWorkflowOperations when the parent is a batch workflow. Use these for total/success/failure stats rather than len(ChildWorkflowOperations). `omitempty` is intentionally omitted: callers distinguish "BE populated these" from "fall back" by field presence, so zero must round-trip.
`childWorkflowOperations`	array<Operation>	no	Only populated if it has child workflows. Otherwise it is nil. May be a truncated page; ChildTotal/ChildCompleted/ChildFailed reflect the full aggregate from Temporal's visibility index.
`endTime`	string	no
`id`	string	no	Operation ID.
`memo`	object	no
`message`	string	no
`name`	string	no
`runId`	string	no	Run ID.
`startTime`	string	no
`status`	string	no
`type`	OperationType	no

Content-Type: application/json

Content-Type: application/json

Spotted something wrong or out of date on this page? Tell us and we'll correct it.