API Reference

Back Next

Request

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

Parameter	Description	Additional Information
dataCollectionId	Required. The system generated unique identifier of the data collection to which you want to add the terms of use or from which you want to remove terms of use.	For more information about how you can use an API to get the unique identifier of a data collection, see Retrieve data collections. To get the unique identifier of a data collection from the Data Marketplace interface, open the data collection. The data collection page's URL contains the unique identifier. For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary , the unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1 .
termsOfUse > termsOfUseId	Required. The system generated unique identifier of the terms of use that you want to add to a data collection or remove from a data collection.	For more information about how you can use an API to get the unique identifier of a terms of use, see Retrieve terms of use.
termsOfUse > operation	Required. The action that you want to perform.	Enter one of the following values: To add terms of use to a data collection, enter ADD . To remove terms of use from a data collection, enter REMOVE .