API Reference > Manage data collections > Retrieve the terms of use of a data collection
  

Retrieve the terms of use of a data collection

Use a REST API to retrieve the terms of use of a data collection.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataCollections/<dataCollectionId>/termsOfUse
<dataCollectionId>: Required. Enter the system generated unique identifier of the data collection for which you want to retrieve the terms of use.
For more information about how you can use an API to get the system generated unique identifier of a data collection, see Retrieve data collections.
To get the system generated unique identifier of a data collection from the Data Marketplace interface, open the data collection. The data collection page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary, the system generated unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1.
Method
GET
Note: Before you call this API, consider the following:
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.
Note: The API has no payload.

Example request

The following example shows how you can use an API call to retrieve the terms of use of a data collection:
https://{{CDMP_URL}}/api/v1/integration/dataCollections/794a215f-5479-4b55-8e1b-a4866ec9fe82/termsOfUse

Response

When you pass the API query parameters in the REST client, the client displays a response for the request query based on the data collection that you specified.
The following example shows the response of an API call to retrieve the terms of use of a data collection:
{
"processingTime": 279,
"offset": 0,
"limit": 1,
"totalCount": 1,
"objects": [
{
"id": "7bb0bcc1-23a9-4ffc-9f39-50c7b4df91b0",
"refId": "TOU-434",
"name": "Retail only",
"description": "This data is only for retail employees.",
"type": "CONTROLLED",
"status": "DISABLED",
"acknowledgement": true,
"referenceLink": null,
"createdBy": "5tSQ0vG66z9jS0KBQkY84r",
"createdOn": "2022-05-17T10:05:21.453Z",
"modifiedBy": "5tSQ0vG66z9jS0KBQkY84r",
"modifiedOn": "2022-05-17T10:06:57.433Z"
}
]
}
The following table describes the parameters of each terms of use that is retrieved:
Parameter
Description
offset
Starting index for the paginated results.
limit
Maximum number of results.
totalCount
Number of terms of use retrieved.
id
System generated unique identifier of the terms of use.
refId
Reference identifier of the terms of use.
name
Name of the terms of use.
description
Description of the terms of use.
type
Type of the terms of use. A terms of use can have one of the following types:
  • - ACCESSIBLE
  • - CONTROLLED
  • - RESTRICTED
status
The status indicates whether the terms of use are available to be added to data collections. A terms of use can have one of the following statuses:
  • - ENABLED. The terms of use are available to be added to data collections.
  • - DISABLED. The terms of use isn't available to be added to data collections.
acknowledgement
This parameter indicates whether the Data User is required to acknowledge the terms of use when they place an order. The parameter can be one of the following values:
  • - true. The Data User must acknowledge the terms of use when they place an order.
  • - false. The Data User doesn't need to acknowledge the terms of use when they place an order.
referenceLink
Uniform resource identifier of the terms of use.
createdBy
System generated unique identifier of the user account that created the terms of use.
createdOn
Date when the terms of use was created.
modifiedBy
System generated unique identifier of the latest user account that modified the terms of use.
modifiedOn
Latest date when the terms of use was modified.