AM/FA/Inv - Get Orchestration Details

Details

/external/v1/transactions/orchestrations

Synopsis

Get Orchestration Details

get

This route is used to retrieve the details of orchestrations, given a set of search filters. This endpoint is paginated, up to 50 records can be retrieved per call. This endpoint can be called by applications with access to scope "readTransactionData".

Required scopes

This endpoint requires the following scopes:

• : readTransactionData

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

orchestrationIdsFilterstringOptional

The comma delimited list of orchestration ids to filter the orchestration records. Up to 50 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bf

orchestrationStatusFilterstringOptional

The comma delimited list of statuses to filter the orchestration records. Up to 5 entries can be provided.Available values: queued, in_progress, success, failed, dlq

Example: queued,success

sourceTransactionIdsFilterstringOptional

The comma delimited list of source db transaction ids to filter the orchestration records. Up to 50 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,2159457f-0167-4e93-a969-9cf0db05e0bf

Responses

200

Successfully retrieved orchestration details

application/json

400

The following error codes can be returned: - GN0002 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/transactions/orchestrations

HTTPcURLJavaScriptPython

GET /external/v1/transactions/orchestrations HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "orchestrationId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "startDate": "2024-09-12T00:00:00.000Z",
    "status": "success",
    "timestamp": "2024-09-12T00:00:00.000Z",
    "processIds": [
      "12340c1e2-1c4b-4b8b-9a6e-2b5e4e5f5678",
      "abcdc1e2-1c4b-4b8b-9a6e-2b5e4e5fmnbv"
    ],
    "sourceTransactionId": "12340c1e2-1c4b-4b8b-9a6e-2b5e4e5f5678",
    "currentStep": 1,
    "createdDate": "2024-09-12T00:00:00.000Z"
  }
]