The Corastone platform currently supports associating comments with specific assets. Comments can provide information to each of the parties involved in the life cycle of the asset. Comments can also remain internal to the commenting organization.
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"
]
}
}This route is used to add a comment associated to entities. This action can be broadcast to all the counterparties that have access to these entities.
This will trigger an asynchronous process which can be monitored using the "Transactions API" endpoints.
This endpoint can be called by applications with access to scope "manageComments".
This property contains the transactional data information
{"signer":{"email":"[email protected]","name":"John Doe"},"extraData":{"someCustom":"property to be shared"}}This property defines if the comment information will be sent to all counterparties.
falseExample: trueThis property contains the counterparties that will receive the comment information. It is optional.
If not provided it will be sent to all counterparties that are entitled to the entity this comment is related to.
["ORG1","ORG2"]This is the booked unique identifier of the comment. It is optional.
USS3JKS01I00SW24This property contains the comment message. It is optional. Should be provided if no documents are attached.
an example comment messageThe list of entities to associate to the comment
{"assetIds":["US9QIASSET1","US9QIASSET2"]}POST /external/v1/comment HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 710
{
"transactionData": {
"signer": {
"email": "[email protected]",
"name": "John Doe"
},
"extraData": {
"someCustom": "property to be shared"
}
},
"broadcastToCounterparty": true,
"counterparties": [
"ORG1",
"ORG2"
],
"bookedCommentId": "USS3JKS01I00SW24",
"message": "an example comment message",
"associatedEntities": {
"assetIds": [
"US9QIASSET1",
"US9QIASSET2"
]
},
"documents": [
{
"uploadData": {
"type": "IdentityVerification",
"extension": "pdf",
"name": "John Doe ID",
"link": "https://test-storage.s3.amazonaws.com/some-id.pdf",
"correlationData": [
{
"broadcastToCounterparty": true,
"correlationId": "123245573717",
"origin": "Identifies file on backoffice",
"extraData": {
"some": "Custom Property"
}
}
]
},
"extraData": {
"someCustom": "property to be shared"
}
}
]
}{
"processData": {
"processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
"orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
}
}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 block on the ledger.
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".
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 block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$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/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"timestamp": "2024-09-12T00:00:00.000Z",
"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"
]
},
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
}
},
"signerData": {
"email": "[email protected]",
"name": "John Doe"
},
"extraData": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
}
}
]