AM/TA/Inv - Get Organization History

Details

/external/v1/org/history

Synopsis

Get Organization History

get

This route is used to get organization history given a set of filters such as blockchain details or organization identifiers. The requests should be paginated with up to 100 entries per call. This endpoint can be called by applications with access to scope "readOrgs".

Required scopes

This endpoint requires the following scopes:

• : readOrgs

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

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

orgIdsFilterstringOptional

The comma delimited list of organization ids to filter the organization records. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

orgCorrelationIdsFilterstringOptional

The comma delimited list of organization correlation ids to filter the organization records. Up to 25 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

orgCorrelationOrgIdstring · max: 12Optional

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

Responses

200

Successfully returned org history

application/json

timestampstring · date-timeRequired

The timestamp of the action

Example: 2024-09-12T00:00:00.000Z

affectedOrgIdstring · max: 50Required

The id of the affected organization. Used to uniquely identify the organization on the ledger

Example: US9QIMA

blockNumbernumberRequired

The block number where the organization history was recorded on the ledger.

Example: 350

transactionIdstringRequired

The transaction id where the organization history was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where the organization history was recorded on the ledger.

Example: OG123

eventall ofRequired

The type of the organization action.

Example: Updated

string · enumOptional

The type of the organization action.

Possible values:

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/org/history

HTTPcURLJavaScriptPython

GET /external/v1/org/history HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "affectedOrgId": "US9QIMA",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "event": "Updated",
    "update": {
      "orgId": "US9QIMA",
      "name": "Organization Name",
      "status": "ready",
      "integrationApiAddress": "http://127.0.0.1:30003",
      "accountType": "investor",
      "version": null,
      "outboundAddressList": [
        {
          "address": "outbound.org.com"
        }
      ],
      "peers": [
        {
          "key": "peer0",
          "domainName": "peer0.org.com",
          "requestPort": 7051,
          "eventPort": 7053
        }
      ],
      "orgACL": [
        "US9QIMB"
      ],
      "extraData": null
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    },
    "extraData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    }
  }
]