An operation's state, with its class.

GET

/v1/operations/{reference}

const url = 'https://example.com/v1/operations/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/operations/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Path Parameters

reference

required

string

A did:aledgent identifier.

Responses

200

The operation’s state, with its class (REQ-OP-7).

application/json

operation(reference) (SPEC §8.2, F-011): the state the core holds, with its class (REQ-OP-7), its deadline, evidence, outcome, refusal and postings. A command decided and complete at once has no lifecycle state and is terminal.

object

class

Any of:

unknown
null

One of:

Terminal: the outcome is final.

string

Allowed value: terminal

Needs-Review: waiting for a human. Not terminal and not refunding.

string

Allowed value: awaiting-human

closed_at

When it reached its terminal state.

integer | null format: uint64

command

The command that opened it, where recorded.

string | null

deadline

Its deadline, where not terminal.

integer | null format: uint64

error

Any of:

Refusal
null

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

evidence

The digests of the evidence its transitions rest on, hex.

Array<string>

kind

Its lifecycle kind, where it has a lifecycle.

string | null

operation_reference

required

The operation reference.

string

outcome

The terminal state, where terminal.

string | null

postings

The posting sequence numbers it appended.

Array<integer>

reference

Any of:

unknown
null

Pass-through data (REQ-PO-5): any one JSON value, at most 1024 bytes of UTF-8 as sent. Kept and echoed exactly as sent; never read by aledgent. Over the bound, or not one JSON value, the command is refused with ERR-MalformedCommand.

state

Its state, where it has a lifecycle.

string | null

terminal

required

Whether it is terminal. false for every state that is not.

boolean

Example

{
  "class": "terminal",
  "error": {
    "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
    "error": "ERR-NotAuthorised"
  }
}

4XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

5XX

Refused, with the named condition. The status is the alternative’s x-http-status.

application/json

One of:

ERR-NotAuthorised

object

description

required

Allowed value: The initiating principal holds no authority that covers this operation, account, asset or bound

error

required

Allowed value: ERR-NotAuthorised

Example

{
  "description": "The initiating principal holds no authority that covers this operation, account, asset or bound",
  "error": "ERR-NotAuthorised"
}

Headers

Retry-After

integer

On ERR-DecisionUnavailable (503): seconds to wait before retrying with the same client key (DEC-27 (g)).