AM/TA/Inv - Get Sync Job Sequence Data

Details

/external/v1/sequencer/sync-job

Synopsis

Get Sync Job Sequence Data

get

This route is used to retrieve the sequence of events that happened within a sync job and a particular timeframe. This includes transactions, errors, and orchestrations, ordered by timestamp in an ascending order. This endpoint is paginated, up to 250 records can be retrieved per call. This endpoint can be called by applications with access to scope "readSequencer".

Required scopes

This endpoint requires the following scopes:

• : readSequencer

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).

fromDatestring · date-timeOptional

The start date from which the transactions are to be retrieved. If not provided then the system will retrieve transactions from the very first record.

toDatestring · date-timeOptional

The end date until which the transactions are to be retrieved. If not provided then the current timestamp will be considered.

syncJobIdstringRequired

The id of the sync job we want to filter the transactions by and return sequencer entries.

Example: 3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b

Responses

200

Successfully retrieved sync job sequence data

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/sequencer/sync-job

HTTPcURLJavaScriptPython

GET /external/v1/sequencer/sync-job?syncJobId=3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "sequence": [
    {
      "transaction": {
        "processId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
        "timestamp": "2024-09-12T00:00:00.000Z",
        "status": "success",
        "orchestrationId": "1234c1e2-1c4b-9865-9a6e-2b5e4e5f6555",
        "type": "issuance",
        "method": "createInvestment",
        "orgId": "OG123",
        "blockchainDetails": {
          "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
          "blockNumber": 350,
          "channelName": "og123"
        },
        "details": {
          "assetIds": [
            "US9QIMAOAS1Q",
            "US9QI5647S1P"
          ],
          "securityIds": [
            "USCCWSF01I00"
          ]
        }
      }
    },
    {
      "error": {
        "errorId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
        "timestamp": "2024-09-12T00:00:00.000Z",
        "action": {
          "httpData": {
            "method": "POST",
            "url": "/v1/external/error-log"
          },
          "name": "Create Error Log Record",
          "id": "PM001"
        }
      }
    },
    {
      "orchestration": {
        "orchestrationId": "1234c1e2-1c4b-9865-9a6e-2b5e4e5f6555",
        "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"
        ]
      }
    }
  ],
  "grantedTxnEntitlements": [
    {
      "processId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
      "timestamp": "2024-09-12T00:00:00.000Z",
      "status": "success",
      "orchestrationId": "1234c1e2-1c4b-9865-9a6e-2b5e4e5f6555",
      "type": "referenceData",
      "method": "setReferenceDataHash",
      "orgId": "OG123",
      "blockchainDetails": {
        "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
        "blockNumber": 350,
        "channelName": "og123"
      },
      "details": {
        "investorIds": [
          "US9QIMAOAS1Q"
        ],
        "accountIds": [
          "US9QI5678S1P"
        ],
        "fileIds": [
          "US9QIMLKJ1Q",
          "US9QIYUHTS5L"
        ],
        "advisorIds": [
          "US9QIYHJKRDF"
        ]
      }
    }
  ]
}