API Reference

Back Next

Endpoint and method

The following table describes the connection properties for the API:

Property	Description
Endpoint	/api/v1/integration/dataCollections/<id> <id> : Required. Enter the system generated unique identifier of the data collection that you want to delete. 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 .
Method	DELETE

Property

Description

Endpoint

/api/v1/integration/dataCollections/<id>

<id>

: Required. Enter the system generated unique identifier of the data collection that you want to delete.

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

Method

DELETE

If the data collection that you want to delete is linked to another collection, this link is removed when you delete the data collection. In this scenario, the other collection that was linked does not get deleted.

You can call a maximum of 100 APIs per minute.

Delete data collections

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal