AM/FA/Inv - Get Comment Details

Details

/external/v1/comment

Synopsis

Get Comment Details

get

This route is used to retrieve the details of an comment, given a set of search filters. 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).

assetIdsFilterstringOptional

The comma delimited list of asset ids to filter the comment records. Up to 50 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 comment 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.

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 details

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/comment

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "commentId": "US9QICOMMENT1",
    "replyToCommentId": "US9QICOMMENT1",
    "message": "This is a comment",
    "userInfo": {
      "name": "John Doe",
      "email": "[email protected]",
      "team": "Compliance"
    },
    "status": "broadcast",
    "viewOrgs": [
      "US9QIORG1",
      "US9QIORG2"
    ],
    "fileIds": [
      "US9QIFILE1",
      "US9QIFILE2"
    ],
    "type": "review",
    "category": "EC002",
    "flaggedDocument": {
      "document": {
        "fileId": "FILE3JUS03I04"
      },
      "details": {
        "issueType": "mismatch",
        "pageNumber": 1,
        "additionalNotes": "The signature on the top of the page is different than expected according to the provided ID document"
      }
    },
    "reviewStatus": "resolved",
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "associatedEntities": {
      "assetIds": [
        "US9QIASSET1",
        "US9QIASSET2"
      ]
    }
  }
]