Comment on an object

Use REST APIs to add a comment on one of the following sections in Data Marketplace:

•On the Chat panel of a data asset, data collection or category.
•On the Timeline section of an order, consumer access or data collection request.

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/integration/collaboration/<objectId>/interactions/comments <objectId>: Required. Enter the system generated unique identifier of the object to which you want to add a comment. For more information about how you can retrieve the system generated unique identifier of an object, How do I retrieve the system-generated unique identifier of a Data Marketplace item?.
Method	POST

For more information about how you can call an API, see Authenticate using Application Integration.

The following table describes the parameters that you enter in the body of the API payload:

Parameter	Description	Additional Information
text	Required. Enter your comment.	Enter a comment with length from 0 through 500 characters. Note: If you use an API to add a comment, you cannot tag a user in your comment. To tag a user, add a comment from the Data Marketplace user interface. For more information, see the Collaboration in Data Marketplace topic in the Introduction and Getting Started help.

The following example shows how you can use an API to add a comment to a data collection:

{
"text": "This data collection does not cover the EMEA region data."
}

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.

The following example shows the response of an API call to add a comment to a data collection:

{
"id": "49d4856a-90b3-3584-abd6-47db0fe9acb6"
}

The following table describes the parameters of each custom field that is retrieved:

Parameter	Description
id	System generated unique identifier of the comment that you added.