API Reference > Miscellaneous APIs > Collaboration on objects

Collaboration on objects

You can collaborate with other users in Data Marketplace. This allows you to enhance the quality of data that is available in your organization's Data Marketplace, and allows you to extract more business value from your organization's data.

You can collaborate with other users in the following sections of 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.

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 object?.
Method	POST

Request

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.

Example request

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

Response

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.

Retrieve comments on an object

Use REST APIs to retrieve the comments that are added to 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 object?.
Method	GET

Note: Before you call this API, consider the following:

•If you use an Application Integration system service action to invoke this API, you can call a maximum of 100 APIs per minute.
•If you use JWT authentication to invoke this API, you can call a maximum of 120 APIs per minute and 10,000 APIs per day.

For more information, see How to call a Data Marketplace API.

Request

The following table describes the parameters that you enter in the request query:

Parameter	Description	Additional Information
offset	Optional. Enter the starting index for the paginated results.	Default value is 0.
limit	Optional. Enter the maximum number of results.	Default value is 50. Maximum value is 100.

Example request

The following example shows how you can use an API to retrieve the comments that are added to a data collection:

https://{{CDMP_URL}}/api/v1/integration/collaboration/8c4c2089-6c7e-4696-a8f6-44f87639d65c/interactions/comments

Response

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 retrieve the comments that are added to a data collection:

{
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"id": "49d4856a-90b3-3584-abd6-47db0fe9acb6",
"text": "This data collection does not cover the EMEA region data.",
"createdBy": "7w2uGIARApUgxniNoHHWsJ",
"createdOn": "2022-03-08T17:05:28.208Z",
"modifiedBy": "7w2uGIARApUgxniNoHHWsJ",
"modifiedOn": "2022-03-08T17:09:34.623Z"
}
]
}

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

Parameter	Description
offset	Starting index for the paginated results.
limit	Maximum number of results.
id	System generated unique identifier of the comment.
text	Contents of the comment.
createdBy	System generated unique identifier of the user account that added the comment.
createdOn	Date when the comment was added.
modifiedBy	System generated unique identifier of the latest user account that modified the comment.
modifiedOn	Latest date when the comment was modified.