AM/TA/Inv - Get Comment History

Details

/external/v1/comment/history

Synopsis

Get Comment History

get

This route is used to retrieve the history data entries of comments given a set of filters such as blockchain details or comment identifiers. The history entries will reflect the state of the comments on a particular timestamp. If broadcasted to counterparties, the history will also contain the blockchain details. This endpoint returns paginated data. Up to 250 can be extracted per call. This endpoint can be called by applications with access to scope "readComments".

Required scopes

This endpoint requires the following scopes:

• : readComments

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

processIdsFilterstringOptional

The comma delimited list of transaction process ids to filter the comment history records. Up to 250 records can be provided. Each record should be a UUID v4 value.

Example: bbb562cc-636a-48c0-9d77-ba1f1b15da07,

commentIdsFilterstringOptional

The comma delimited list of comment ids to filter the comment records. Up to 250 records can be provided. Each record should not exceed 16 characters.

Example: USCCWSF01I00,USCCWSF01I01

Responses

200

Successfully retrieved the Comment history

application/json

timestampstring · date-timeRequired

The timestamp of the action

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

processIdstringRequired

The unique identifier of the transaction that generated this history record

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

blockNumbernumberOptional

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

Example: 350

transactionIdstringOptional

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

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringOptional

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

Example: OG123

eventall ofRequired

The type of the comment action.

Example: Created

string · enumOptional

The type of the comment 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/comment/history

HTTPcURLJavaScriptPython

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

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "processId": "3f50c1e2-1c4b-4b8b-9a6e-2b5e4e5f6a7b",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "event": "Created",
    "update": {
      "commentId": "US9QICOMMENT1",
      "message": "This is a comment",
      "status": "broadcast",
      "viewOrgs": [
        "US9QIORG1",
        "US9QIORG2"
      ],
      "fileIds": [
        "US9QIFILE1",
        "US9QIFILE2"
      ],
      "associatedEntities": {
        "assetIds": [
          "US9QIASSET1"
        ]
      },
      "type": "review",
      "reviewStatus": "resolved",
      "organization": {
        "orgId": "TEST1234",
        "name": "Test Organization"
      }
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    },
    "extraData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    }
  }
]