AM/FA/Inv - Add Comment

Details

/external/v1/comment

Synopsis

Add Comment

post

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

Required scopes

This endpoint requires the following scopes:

• : manageComments

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Body

application/json

transactionDataall ofRequired

This property contains the transactional data information

Example: {"signer":{"email":"[email protected]","name":"John Doe"},"extraData":{"someCustom":"property to be shared"}}

broadcastToCounterpartybooleanOptional

This property defines if the comment information will be sent to all counterparties.

Default: falseExample: true

counterpartiesstring[]Optional

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

Example: ["ORG1","ORG2"]

bookedCommentIdstring · max: 16Optional

This is the booked unique identifier of the comment. It is optional.

Example: USS3JKS01I00SW24

messagestring · max: 3000Optional

This property contains the comment message. It is optional. Should be provided if no documents are attached.

Example: an example comment message

userInfoall ofOptional

Information about the user who made the comment

Example: {"name":"John Doe","email":"[email protected]","team":"Compliance"}

associatedEntitiesall ofRequired

The list of entities to associate to the comment

Example: {"assetIds":["US9QIASSET1","US9QIASSET2"]}

Responses

201

Successfully added (or, if the action is being broadcast, triggered the addition of) the comment.

application/json

400

The following error codes can be returned: - GN0002 - CM0001 - CM0004 - CM0007 - CM0008 - CM0009 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

404

The following error codes can be returned: - IS0009 - AS0001 - CM0002 - CM0006 Please refer to the error code dictionary for the details of each error code.

application/json

409

The following error codes can be returned: Please refer to the error code dictionary for the details of each error code.

application/json

post

/external/v1/comment

HTTPcURLJavaScriptPython

POST /external/v1/comment HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 835

{
  "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",
  "userInfo": {
    "name": "John Doe",
    "email": "[email protected]",
    "team": "Compliance"
  },
  "associatedEntities": {
    "assetIds": [
      "US9QIASSET1",
      "US9QIASSET2"
    ]
  },
  "documents": [
    {
      "uploadData": {
        "type": "AdditionalSubscriptionTerms",
        "extension": "pdf",
        "name": "Subscription Terms",
        "link": "https://test-storage.s3.amazonaws.com/sub-terms.pdf",
        "correlationData": [
          {
            "broadcastToCounterparty": true,
            "correlationId": "123245573717",
            "origin": "Identifies file on backoffice",
            "extraData": {
              "some": "Custom Property"
            }
          }
        ]
      },
      "extraData": {
        "someCustom": "property to be shared"
      }
    },
    {
      "fileId": "FILE3JUS03I04"
    }
  ]
}

{
  "processData": {
    "processId": "2159457f-0167-4e93-a969-9cf0db05e0bf",
    "orchestrationId": "2159457f-0167-4e93-a969-9cf0db05e0bf"
  }
}