AM/FA/Inv - Get Asset Capital Event History

Details

/external/v1/capital-events/assets/history

Synopsis

Get Asset Capital Event History

get

This route is used to retrieve the history data entries of all assets capital events on the ledger, given a set of search filters.

The history entries will reflect the state of the assets capital events on that particular block.

This endpoint returns paginated data. Up to 100 can be extracted per call.

This endpoint can be called by applications with access to scope "readCapitalEvent".

Authorizations

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

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

capitalEventCorrelationIdsFilterstringOptional

The comma delimited list of capital event correlation ids to filter the asset capital event history records. Up to 100 records can be provided. Each record should not exceed 100 characters.

Example: USCCWSF01I00,USCCWSF01I01

capitalEventCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

capitalEventIdsFilterstringOptional

The comma delimited list of capital event ids to filter the asset capital event history records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

assetIdsFilterstringOptional

The comma delimited list of asset ids to filter the asset capital event history records. Up to 500 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

assetCorrelationIdsFilterstringOptional

The comma delimited list of asset correlation ids to filter the asset capital event history records. Up to 50 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

assetCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved the Asset Capital Event history

application/json

400

The following error codes can be returned: - GN0002 - TX0006 - 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

HTTPcURLJavaScriptPython

GET /external/v1/capital-events/assets/history HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "signerData": {
      "name": "John Doe",
      "email": "[email protected]"
    },
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "event": "CapitalCallApplied",
    "update": {
      "assetId": "USS3JKS01",
      "capitalEventId": "US9QIMAOAS1Q",
      "amountCalled": 100000,
      "expenses": 2000,
      "breakdown": [
        {
          "categoryId": "USS3JKS01I00",
          "amount": 90000,
          "extraData": {
            "some": "Custom Data"
          }
        },
        {
          "categoryId": "USS3JKS01I01",
          "amount": 10000
        }
      ],
      "status": "draft",
      "extraData": {
        "some": "Extra Data"
      }
    }
  }
]