AM/FA - Get Breakdown Categories History

Details

/external/v1/capital-events/categories/history

Synopsis

Get Breakdown categories History

get

This route is used to retrieve the history data entries of breakdown categories given a set of filters such as blockchain details or categories identifiers.

The history entries will reflect the state of the breakdown categories on a particular block on the ledger.

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-]*$

breakdownCategoryIdsFilterstringOptional

The comma delimited list of breakdown category ids to filter the category records. Up to 100 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully retrieved the breakdown categories history

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

HTTPcURLJavaScriptPython

GET /external/v1/capital-events/categories/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": "Published",
    "update": {
      "securityId": "USS3AAS34CKH",
      "categoryId": "USS3JKS01I00",
      "status": "published",
      "type": "investments",
      "flowType": "againstCommitment",
      "description": "Call from LPs, on behalf of GP share of a capital call",
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      }
    }
  }
]