openstead
APIEndpoint referenceServices

Get service operation progress

Returns the actual queued/running/complete/failed state of a job belonging to this workspace and service. Internal payloads and error details are not exposed.

Suggest a change

Kept in memory for this page. Requests go through this documentation site to the live Openstead API and can change your workspace. Use a read-only key to explore read operations.

GET
/workspaces/{workspaceId}/services/{serviceId}/operations/{operationId}

Returns the actual queued/running/complete/failed state of a job belonging to this workspace and service. Internal payloads and error details are not exposed.

Authorization

AuthorizationBearer <token>

Workspace-scoped rnv_ API key. Read scope allows GET; write scope is additionally constrained by current membership, role, email verification, expiry and workspace MFA policy.

In: header

Path Parameters

workspaceId*string

Workspace UUID; it must match the bearer key scope.

Formatuuid
serviceId*string

Service UUID in this workspace.

Formatuuid
operationId*string

Operation UUID in this service.

Formatuuid

Header Parameters

X-Request-ID?string

Optional correlation identifier; invalid values are replaced. The accepted/generated value is returned in X-Request-ID and error body requestId. This is not an idempotency key.

Match^[A-Za-z0-9][A-Za-z0-9._-]*$
Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.openstead.tech/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/services/497f6eca-6276-4993-bfeb-53cbbbba6f08/operations/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <OPENSTEAD_API_KEY>"
{  "operation": {    "createdAt": "2019-08-24T14:15:22Z",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "kind": "string",    "status": "queued",    "updatedAt": "2019-08-24T14:15:22Z"  }}
Need a hand? Contact Openstead support.