Get a workflow instance history by id

Get a workflow instance history by id

GET /api/orchestration/instances/{instanceID}/history

Try it

Get a workflow instance history by id

cURL

curl --request GET \
  --url http://localhost/api/orchestration/instances/{instanceID}/history \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "name": "<string>",
      "input": {
        "amount": {
          "asset": "<string>",
          "amount": 123
        },
        "destination": {
          "wallet": {
            "id": "<string>",
            "balance": "<string>"
          },
          "account": {
            "id": "<string>",
            "ledger": "<string>"
          },
          "payment": {
            "psp": "<string>"
          }
        },
        "source": {
          "wallet": {
            "id": "<string>",
            "balance": "<string>"
          },
          "account": {
            "id": "<string>",
            "ledger": "<string>"
          },
          "payment": {
            "id": "<string>"
          }
        },
        "metadata": {},
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "terminated": true,
      "startedAt": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "terminatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

instanceID · string · required

The instance id

Response

200

application/json

The workflow instance history

data · object[] · required

Show child attributes

data. name · string · required

data. input · object · required

Option 1

Show child attributes

data.input. amount · object

Show child attributes

data.input.amount. asset · string · required

The asset of the monetary value.

data.input.amount. amount · integer<bigint> · required

The amount of the monetary value.

data.input. destination · object

Show child attributes

data.input.destination. wallet · object

Show child attributes

data.input.destination.wallet. id · string · required

data.input.destination.wallet. balance · string

data.input.destination. account · object

Show child attributes

data.input.destination.account. id · string · required

data.input.destination.account. ledger · string

data.input.destination. payment · object

Show child attributes

data.input.destination.payment. psp · string · required

data.input. source · object

Show child attributes

data.input.source. wallet · object

Show child attributes

data.input.source.wallet. id · string · required

data.input.source.wallet. balance · string

data.input.source. account · object

Show child attributes

data.input.source.account. id · string · required

data.input.source.account. ledger · string

data.input.source. payment · object

Show child attributes

data.input.source.payment. id · string · required

data.input. metadata · object

Show child attributes

data.input.metadata. {key} · string

data.input. timestamp · string<date-time>

data. terminated · boolean · required

data. startedAt · string<date-time> · required

data. error · string

data. terminatedAt · string<date-time>