Operation Invocations
2 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/operation-invocations | List operation invocations |
| GET | /api/v1/operation-invocations/{invocationId}/result | Get an operation invocation result |
List operation invocations
GET/api/v1/operation-invocations
List operation invocation status and metadata. Failed executions include a safe diagnostic code, message, retryability, and definition field when known. SQL and input values are never included.
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
| projectId | string | optional | Filters results to the specified Project. Applies to List operation invocations. |
| environmentId | string | optional | Selects the active Project environment coordinate. Applies to List operation invocations. |
| agentId | string | optional | Selects the Project Agent by its stable identifier. Applies to List operation invocations. |
| status | "queued" | "running" | "success" | "domain-failure" | "infra-failure" | "awaiting-approval" | "approval-rejected" | "skipped" | "denied" | "expired" | optional | Filters results to the requested status. Applies to List operation invocations. |
| requestKey | string | optional | Correlates operation invocations with the originating request. Applies to List operation invocations. |
| limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List operation invocations. |
| cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List operation invocations. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
Get an operation invocation result
GET/api/v1/operation-invocations/{invocationId}/result
Read the committed Command result for the invocation using the issuing principal and optional actor personalization; this endpoint never dispatches work.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
| invocationId | string | required | Identifies the operation invocation whose committed result is being read. Applies to Get an operation invocation result. |
query
| Name | Type | Required | Description |
|---|---|---|---|
| actorUserId | string | optional | Selects the external actor whose personalized Workflow authorization is being checked. Applies to Get an operation invocation result. |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Response for status 200 | application/json object
|
| 400 | Bad Request | application/json PublicApiError
|
| 401 | Authentication failed. Possible reasons: - Authorization header is not provided - Invalid API key - Session expired | application/json PublicApiError
|
| 403 | Access denied. The authenticated user does not have permission to perform this action. | application/json PublicApiError
|
| 404 | Resource not found. | application/json PublicApiError
|
| 422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json PublicApiError
|
| 500 | The server could not complete the request. | application/json PublicApiError
|
| 503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json PublicApiError
|