Operation status

GET

/flow/v1/operations/{operationUuid}/status

Returns the current status of an operation, its action-code classification and whether that status is final. A lightweight alternative to the full operation detail when only the lifecycle state is needed (for example, polling).

status is the operation's lifecycle state. actionCode groups statuses by outcome: INITIATED while still in progress (CREATED, OPENED), ACCEPTED once COMPLETED, and DENIED for REJECTED, EXPIRED, CANCELLED and NOT_DELIVERED. final is true once the operation has reached a terminal state and will no longer change.

Autorizaciones

OAuth2

OAuth2 security scheme

clientCredentials Flow

URL del token"/api/v2/auth/token"

Scopes:

• "zertiban-api"Access to the API

Parámetros

Header Parameters

x-tenant-id*

Tenant identifier that contains the organisation UUID

Tipo

string

Requerido

Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"

Formato

"uuid"

Path Parameters

operationUuid*

UUID of the operation whose status is requested

Tipo

string

Requerido

Formato

"uuid"

Respuestas

Operation status

Content-Type

application/json

{

  

"status": "OPENED",

  

"actionCode": "INITIATED",

  

"final": false

}

GET

/flow/v1/operations/{operationUuid}/status

Playground

Servidor

Autorización

OAuth2

Headers

x-tenant-id*

Variables

Key

Value

operationUuid*

Ejemplos