API Reference > Part II: Authenticate using JWT > Define settings for data collections > Categories
  

Categories

A category is a grouping of related data collections. It is a predefined classification where stakeholders can publish the data collections for which they are responsible.

Create categories

Use a REST API to create categories in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/categories
Method
POST
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
parentCategoryId
Optional. Enter the system-generated unique identifier of the parent category for the category that you want to create.
If the category that you want to create isn't a subcategory to another category, you can leave this parameter empty.
For more information about how you can use an API to get the system-generated unique identifier of a category, see Retrieve all categories.
To get the system-generated unique identifier of a category from the Data Marketplace user interface, open the category. The category page's URL contains the system-generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system-generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
externalId
Optional. Enter a reference identifier for the category.
If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the item. The reference identifier that Data Marketplace automatically generates contains a prefix. The administrator can specify the prefix of the automatically generated reference identifier in Metadata Command Center.
If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in Metadata Command Center.
name
Required. Enter a name for the category.
Ensure that you enter a unique value.
Data Marketplace doesn't consider the letter case when it verifies the uniqueness of the name parameter's value. For example, if you try to name a category as "Retail Department" while a category called "Retail department" already exists, the API call fails.
description
Required. Enter a description for the category.
-
status
Required. Specify the status of the category. The status determines whether the category is discoverable and usable in Data Marketplace.
Enter one of the following values:
  • - To make the category discoverable and usable in Data Marketplace, enter ACTIVE.
  • - To make the category not discoverable and unusable in Data Marketplace, enter INACTIVE.
-
assetGroups
Optional. Enter the system-generated unique identifier of the asset group for the category.
Asset groups enable you to control access to the category, the subcategories and data collections within it.
For more information about asset groups, see the Implement access controls on metadata topic in the Set Up Data Marketplace help.
To get the system-generated unique identifier of an asset group, navigate to My Services > Metadata Command Center > Customize. On the Customize page, select the Asset Groups tab. On the Asset Groups tab, click an asset group. The user role page's URL contains the unique identifier.
For example, in the URL /assetGroup/07a3ef9c-9410-421f-9b21-64ec9ac9778f, the unique identifier is 07a3ef9c-9410-421f-9b21-64ec9ac9778f.
stakeholdership > stakeholderId
Optional. Enter the system-generated unique identifier of the user account or user group that you want to assign as a stakeholder on the category.
  • - To get the system-generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the unique identifier is 0LH3xBJC9A6haZ26htGZyT.
  • - To get the system-generated unique identifier of a user group, navigate to My Services > Administrator > User Groups. On the User Groups page, click a user group. The user group page's URL contains the unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the unique identifier is 90uizkSWg0ycuu7hSNXSW4.
stakeholdership > roleId
Optional. Enter the system-generated unique identifier of the user role that is assigned to the stakeholder that you specified in the stakeholderId parameter.
If you specify a value for the stakeholderId parameter, ensure that you also specify a value for the roleId parameter.
To get the system-generated unique identifier of a user role, navigate to My Services > Administrator > User Roles. On the User Roles page, click a user role. The user role page's URL contains the unique identifier.
For example, in the URL /cloudUI/products/administer/main/userRolesAsset/90uizkSWg0ycuu7hSNXSW4, the unique identifier is 90uizkSWg0ycuu7hSNXSW4.

Example request

The following example shows how you can use an API to create a category:
{
"parentCategoryId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"externalId": "CAT-1",
"name": "Sales",
"description": "Data collections related to sales made by the organization.",
"status": "INACTIVE",
"assetGroups": [
"b93c4539-a93e-440d-a4b4-95d69b8911e6"
],
"stakeholdership": [
{
"stakeholderId": "jqPFaKmJRGhdfJ35eWUzoW",
"roleId": "5Qvy6Uiiq9IjoocWeJhccW"
}
]
}

Response

When you invoke the API using a 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 create a category:
{
"externalId": "CAT-123",
"id": "2593524d-82f7-4dfd-bc6b-17088c046f9d",
"name": "Sales",
"description": "Data collections related to sales made by the organization.",
"status": "INACTIVE",
"effectiveStatus": "INACTIVE",
"assetGroups": [
{
"name": "ASIA",
"id": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"isInherited": false
}
]
}
The following table describes the parameters of each category that is created:
Parameter
Description
externalId
Reference identifier of the category.
id
System-generated unique identifier of the category.
name
Name of the category.
description
Description of the category.
status
Status of the category. A category can have one of the following statuses:
  • - ACTIVE
  • - INACTIVE
effectiveStatus
Indicates whether the category is available in Data Marketplace. A category can have one of the following statuses:
  • - ACTIVE. The category is available.
  • - INACTIVE. The category is unavailable.
assetGroups
Details of the asset group that is assigned to the category.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.

Retrieve a category

Use a REST API to retrieve the details of an individual category in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/categories/<categoryId>
<categoryID>: Required. Enter the system-generated unique identifier of the category for which you want to retrieve the details.
To get the system-generated unique identifier of a category from the Data Marketplace user interface, open the category. The category page's URL contains the system-generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system-generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
Method
GET
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
segments
Optional. Specify the type of details that you want the API request to return.
Enter one or more of the following values:
  • - all. Returns all the details about the category.
  • - parentCategory. Returns the details about the parent category that contains the category.
  • - systemAttributes. Returns the details about the category's creation and modification, such as the details of the user that created the category, the latest user that modified the category, and so on.
  • - stakeholdership. Returns the type of user and role that are assigned as stakeholder on the category.
By default, the parameter is assigned no value and the API response includes only the basic information about the category such as name, description and so on.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of a category:
https://{{CDMP_URL}}/api/v2/categories/2593524d-82f7-4dfd-bc6b-17088c046f9d?segments=all

Response

When you invoke the API using a 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 details of a category:
{
"externalId": "CAT-123",
"id": "2593524d-82f7-4dfd-bc6b-17088c046f9d",
"parentId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"name": "Sales",
"description": "Data collections related to sales made by the organization.",
"status": "INACTIVE",
"effectiveStatus": "INACTIVE",
"parentCategory": {
"id": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"externalId": "CAT-001",
"name": "Financials",
"description": "Data collections related to financial operations.",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"systemAttributes": {
"createdBy": "analyst@company.com",
"createdOn": "2025-08-11T10:30:00Z",
"modifiedBy": "dataowner@company.com",
"modifiedOn": "2025-08-11T15:45:00Z"
},
"href": "/categories/b93c4539-a93e-440d-a4b4-95d69b8911e6"
},
"stakeholdership": [
{
"stakeholderId": "jqPFaKmJRGhdfJ35eWUzoW",
"userType": "USER",
"roleId": "5Qvy6Uiiq9IjoocWeJhccW",
"isInherited": false
}
],
"assetGroups": [
{
"id": "4795b4ac-94a6-413b-9349-64cf455d5abb",
"name": "USA",
"isInherited": false
}
],
"systemAttributes": {
"createdBy": "jaXM6NrqsKXffdwg2NkTMR",
"createdOn": "2025-08-11T10:30:00Z",
"modifiedBy": "jaXM6NrqsKXffdwg2NkTMR",
"modifiedOn": "2025-08-11T15:45:00Z"
}
}
The following table describes the parameters of the category that is retrieved:
Parameter
Description
externalId
Reference identifier of the category.
id
System-generated unique identifier of the category.
parentId
System-generated unique identifier of the parent category.
name
Name of the category.
description
Description of the category.
status
Status of the category as configured by a stakeholder of the category.
A category can have one of the following statuses:
  • - ACTIVE
  • - INACTIVE
effectiveStatus
The effective status of the category indicates whether a category is discoverable and usable in Data Marketplace.
The effective status of a category is influenced by the effective status of its parent category. For example, if the value of the status parameter of a category is Active but the category is added to an effectively inactive parent category, the category becomes inactive.
A category can have one of the following statuses:
  • - ACTIVE. The category is discoverable and usable in Data Marketplace.
  • - INACTIVE. The category isn't discoverable and usable in Data Marketplace.
parentCategory
Details of the parent category.
stakeholdership
Details of the stakeholders of the category.
stakeholdership > stakeholderId
System-generated identifier of the user account or user group that is assigned as a stakeholder of the category.
stakeholdership > userType
Indicates whether the stakeholder is an individual user account or user group.
This parameter can have one of the following values:
  • - USER. The stakeholder is an individual user account.
  • - USER-GROUP. The stakeholder is a user group.
stakeholdership > roleId
System-generated identifier of the user role that is assigned to the stakeholder of the category.
stakeholdership > isInherited
Indicates whether the stakeholder is directly assigned to the category or if the stakeholder is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The stakeholder is inherited from the category hierarchy.
  • - false. The stakeholder is directly assigned to the category.
assetGroups
Details of the asset group that is assigned to the category.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.
systemAttributes > createdBy
System-generated identifier of the user account that created the category.
systemAttributes > createdOn
Date when the category was created.
systemAttributes > modifiedBy
System-generated identifier of the latest user account that modified the category.
systemAttributes > modifiedOn
Latest date when the category was modified.

Retrieve all categories

Use a REST API to retrieve the details of all categories in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/categories
Method
GET
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
segments
Optional. Specify the type of details that you want the API request to return.
Enter one or more of the following values:
  • - all. Returns all the details of each category that is retrieved.
  • - parentCategory. Returns the details of the parent category that contains a category.
  • - systemAttributes. Returns the details about a category's creation and modification, such as the details of the user that created the category, the latest user that modified the category, and so on.
  • - stakeholdership. Returns the type of user and role that are assigned as stakeholder on a category.
By default, the parameter is assigned no value and the API response includes only the basic information about the category such as name, description and so on.
search
Optional. Enter the search term to find a category by name or description.
To retrieve details for all the categories in Data Marketplace, enter an asterisk (*).
Default value is an asterisk (*).
Ensure that the search terms that you enter don't contain an asterisk (*).
offset
Optional. Specify the starting index for the paginated results.
Default value is 0.
limit
Optional. Specify the maximum number of results that are displayed on a page.
Default value is 20.
Maximum value is 200.
sortby
Optional. Specify the parameters to sort the search results.
Enter one of the following values:
  • - id
  • - name
  • - status
  • - createdBy
  • - createdOn
  • - modifiedBy
  • - modifiedOn
Default value is modifiedOn.
sortOrder
Optional. Set the sorting order of the search results.
Enter one of the following values:
  • - To sort the search results by ascending order, enter asc.
  • - To sort the search results by descending order, enter desc.
Default value is desc.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of all categories:
https://{{CDMP_URL}}/api/v2/categories?segments=all

Response

When you invoke the API using a 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 details of all categories:
{
"pageInfo": {
"offset": 40,
"limit": 20,
"totalCount": 120
},
"links": {
"self": {
"href": "/categories?segments=all&offset=40&limit=20"
},
"first": {
"href": "/categories?segments=all&offset=0&limit=20"
},
"next": {
"href": "/categories?segments=all&offset=60&limit=20"
},
"previous": {
"href": "/categories?segments=all&offset=20&limit=20"
},
"last": {
"href": "/categories?segments=all&offset=100&limit=20"
}
},
"items": [
{
"externalId": "CAT-123",
"id": "2593524d-82f7-4dfd-bc6b-17088c046f9d",
"parentId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"name": "Sales",
"description": "Data collections related to sales made by the organization.",
"status": "INACTIVE",
"effectiveStatus": "INACTIVE",
"parentCategory": {
"id": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"externalId": "CAT-001",
"name": "Financials",
"description": "Data collections related to financial operations.",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"systemAttributes": {
"createdBy": "analyst@company.com",
"createdOn": "2025-08-11T10:30:00Z",
"modifiedBy": "dataowner@company.com",
"modifiedOn": "2025-08-11T15:45:00Z"
},
"href": "/categories/b93c4539-a93e-440d-a4b4-95d69b8911e6"
},
"stakeholdership": [
{
"stakeholderId": "jqPFaKmJRGhdfJ35eWUzoW",
"userType": "USER",
"roleId": "5Qvy6Uiiq9IjoocWeJhccW",
"isInherited": false
}
],
"assetGroups": [
{
"id": "4795b4ac-94a6-413b-9349-64cf455d5abb",
"name": "USA",
"isInherited": false
}
],
"systemAttributes": {
"createdBy": "jaXM6NrqsKXffdwg2NkTMR",
"createdOn": "2025-08-11T10:30:00Z",
"modifiedBy": "jaXM6NrqsKXffdwg2NkTMR",
"modifiedOn": "2025-08-11T15:45:00Z"
}
}
]
}
The following table describes the parameters of each category that is retrieved:
Parameter
Description
pageInfo > offset
Starting index of the paginated results.
pageInfo > limit
The maximum number of results that are displayed on a page.
pageInfo > totalCount
Number of categories retrieved.
links > self > href
The API that was invoked to generate this response.
links > first > href
The API endpoint that you can use to retrieve the search results that are displayed on the first page.
links > next > href
The API endpoint that you can use to retrieve the search results from the page following the one you currently have open.
links > previous > href
The API endpoint that you can use to retrieve the search results from the page prior to the one you currently have open.
links > last > href
The API endpoint that you can use to retrieve the search results that are displayed on the last page.
externalId
Reference identifier of the category.
id
System-generated unique identifier of the category.
parentId
System-generated unique identifier of the parent category.
name
Name of the category.
description
Description of the category.
status
Status of the category as configured by a stakeholder of the category.
A category can have one of the following statuses:
  • - ACTIVE
  • - INACTIVE
effectiveStatus
The effective status of the category indicates whether a category is discoverable and usable in Data Marketplace.
The effective status of a category is influenced by the effective status of its parent category. For example, if the value of the status parameter of a category is Active but the category is added to an effectively inactive parent category, the category becomes inactive.
A category can have one of the following statuses:
  • - ACTIVE. The category is discoverable and usable in Data Marketplace.
  • - INACTIVE. The category isn't discoverable and usable in Data Marketplace.
parentCategory
Details of the parent category.
stakeholdership
Details of the stakeholders of the category.
stakeholdership > stakeholderId
System-generated identifier of the user account or user group that is assigned as a stakeholder on the category.
stakeholdership > userType
Indicates whether the stakeholder is an individual user account or user group.
This parameter can have one of the following values:
  • - USER. The stakeholder is an individual user account.
  • - USER-GROUP. The stakeholder is a user group.
stakeholdership > roleId
System-generated identifier of the user role that is assigned to the stakeholder of the category.
stakeholdership > isInherited
Indicates whether the stakeholder is directly assigned to the category or if the stakeholder is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The stakeholder is inherited from the category hierarchy.
  • - false. The stakeholder is directly assigned to the category.
assetGroups
Details of the asset group that is assigned to the category.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.
systemAttributes > createdBy
System-generated identifier of the user account that created the category.
systemAttributes > createdOn
Date when the category was created.
systemAttributes > modifiedBy
System-generated identifier of the latest user account that modified the category.
systemAttributes > modifiedOn
Latest date when the category was modified.

Modify categories

Use a REST API to modify categories in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/categories/<categoryId>
<categoryID>: Required. Enter the system-generated unique identifier of the category that you want to modify.
To get the system-generated unique identifier of a category from the Data Marketplace user interface, open the category. The category page's URL contains the system-generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system-generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
Method
PATCH
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
operation
Required. Specify the type of change you want to make to the category.
Enter one of the following values:
  • - To add a value to a parameter, enter add.
  • - To replace an existing value of a parameter, enter replace.
  • - To remove a value from a parameter, enter remove.
-
segment
Required. Specify the type of details that you want the API request to modify.
Enter one of the following values:
  • - To modify the value specified in the parentCategoryId parameter, enter parentCategory.
  • - To modify the values specified in the name, description, externalId and status parameters, enter summary.
  • - To modify the values specified in the stakeholderId and roleID parameters, enter stakeholdership.
-
name
Optional. Enter a name for the category.
Ensure that you enter a unique value.
Data Marketplace doesn't consider the letter case when it verifies the uniqueness of the name parameter's value. For example, if you try to name a category as "Retail Department" while a category called "Retail department" already exists, the API call fails.
parentCategoryId
Optional. the system-generated unique identifier of the parent category for the category that you want to create.
If you don't want to add this category as a subcategory to another category, you can leave this parameter empty.
For more information about how you can use an API to get the system-generated unique identifier of a category, see Retrieve all categories.
To get the system-generated unique identifier of a category from the Data Marketplace user interface, open the category. The category page's URL contains the system-generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system-generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
description
Optional. Enter a description for the category.
-
externalId
Optional. Enter a reference identifier for the category.
If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the item. The reference identifier that Data Marketplace automatically generates contains a prefix. The administrator can specify the prefix of the automatically generated reference identifier in Metadata Command Center.
If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in Metadata Command Center.
assetGroups
Optional. Specify an asset group for the category.
Asset groups enable you to control access to the category, the subcategories and data collections within it.
For more information about asset groups, see the Implement access controls on metadata topic in the Set Up Data Marketplace help.
status
Optional. Specify the status of the category. The status determines whether the category is discoverable and usable in Data Marketplace.
Enter one of the following values:
  • - To make the category discoverable and usable in Data Marketplace, enter ACTIVE.
  • - To make the category not discoverable and unusable in Data Marketplace, enter INACTIVE.
stakeholdership > stakeholderId
Optional. Enter the system-generated unique identifier of the user account or user group that you want to assign as a stakeholder on the category.
  • - To get the system-generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the unique identifier is 0LH3xBJC9A6haZ26htGZyT.
  • - To get the system-generated unique identifier of a user group, navigate to My Services > Administrator > User Groups. On the User Groups page, click a user group. The user group page's URL contains the unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the unique identifier is 90uizkSWg0ycuu7hSNXSW4.
stakeholdership > roleId
Optional. Enter the system-generated unique identifier of the user role that is assigned to the stakeholder that you specified in the stakeholderId parameter.
If you specify a value for the stakeholderId parameter, ensure that you also specify a value for the roleId parameter.
To get the system-generated unique identifier of a user role, navigate to My Services > Administrator > User Roles. On the User Roles page, click a user role. The user role page's URL contains the unique identifier.
For example, in the URL /cloudUI/products/administer/main/userRolesAsset/90uizkSWg0ycuu7hSNXSW4, the unique identifier is 90uizkSWg0ycuu7hSNXSW4.

Example request

The following example shows how you can use an API to modify a category:
{
"operation": "replace",
"segment": "summary",
"value": {
"name": "Sales",
"description": "Data collections related to sales made by the organization. ",
"externalId": "CAT-001",
"status": "ACTIVE"
}
}

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the category is successfully modified:
204 OK code
If you modify the asset group, parent or stakeholder of a category, the REST client displays the following response code to indicate that a job was created in Metadata Command Center to apply your changes:
202 Accepted code
The following example shows the response of an API call to modify a category for which a job was created in Metadata Command Center to apply the changes:
{
"trackerJobId": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"propagationJobId": "b93c4539-a93e-440d-a4b4-95d69b8911e6"
}
The following table describes the parameters of each job that is created in Metadata Command Center:
Parameter
Description
trackerJobId
System-generated identifier of the job that enables you to track the progress of the job in Metadata Command Center.
For more information about jobs in Metadata Command Center, see the Administration help in Metadata Command Center.
propagationJobId
System-generated identifier of the internal job that applies your changes to Data Marketplace .

Delete categories

Use a REST API to delete categories in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/categories/<categoryId>
<categoryID>: Required. Enter the system-generated unique identifier of the category that you want to delete.
To get the system-generated unique identifier of a category from the Data Marketplace user interface, open the category. The category page's URL contains the system-generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system-generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
Method
DELETE
For more information about how you can call an API, see Authenticate using JWT.

Request

Note: The API has no payload.

Example request

The following example shows how you can use an API to delete a category:
https://{{CDMP_URL}}/api/v2/categories/67417f72-e5ab-44f0-add9-a1e412c1ce13

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the category is successfully deleted:
204 OK code