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".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
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.
USCCWSF01I00,USCCWSF01I01The 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.
1234,5678,7890The 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.
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.
USCCWSF01I00,USCCWSF01I01GET /external/v1/comment HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"extraData": {
"externalId": "123456789",
"some": "Custom Property"
},
"commentId": "US9QICOMMENT1",
"message": "This is a comment",
"status": "broadcast",
"viewOrgs": [
"US9QIORG1",
"US9QIORG2"
],
"fileIds": [
"US9QIFILE1",
"US9QIFILE2"
],
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"associatedEntities": {
"assetIds": [
"US9QIASSET1",
"US9QIASSET2"
]
}
}