API Reference > 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/v1/integration/categories
Method
POST

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
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.
-
dataOwners
Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the category with the Category Owner stakeholder role.
  • - 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the system generated unique identifier is 90uizkSWg0ycuu7hSNXSW4.

Example request

The following example shows how you can use an API to create a category:

{
"items": [
{
"name": "Retail Department",
"description": "This category represents the retail department.",
"dataOwners": [
"e9paNlaKR8MdFJnETEs2k4"
]
}
]
}

Response

When you pass the API payload 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 create a category:

{
"processingTime": 10105,
"objects": [
{
"index": 1,
"id": "2fa40528-410d-4cf6-8ee3-9f3ef328285c",
"refId": "CAT-414",
"name": "Retail Department"
}
]
}

The following table describes the parameters of each category that is created:
Parameter
Description
index
The position of the category in the objects JSON array. This value does not impact how the category is used by a Data Marketplace user.
id
System generated unique identifier of the category.
refId
Reference identifier of the category.
name
Name of the category.

Retrieve categories

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

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/categories
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
search
Optional. Enter the search term that you want to use to find a category.
Ensure that the search term that you enter don't contain an asterisk (*).
fields
Optional. Enter the fields on which the search term applies. The terms that you entered in the search field parameter are used to search the fields that you specify here.
Enter the following values:
  • - NAME
  • - DESCRIPTION
ids
Optional. Enter the system generated unique identifier of a category.
To get the system generated unique identifier of a category, 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.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
dataOwners
Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the category with the Category Owner stakeholder role.
  • - 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the system generated unique identifier is 90uizkSWg0ycuu7hSNXSW4.
status
Optional. Specify the status of the category. The status determines whether the category is available in Data Marketplace.
Enter one of the following values:
  • - To find categories that are available, enter ACTIVE.
  • - To find categories that are unavailable, enter INACTIVE.
createdDateFrom
Optional. To find categories created between a date range, enter the starting date.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the createdDateFrom parameter, ensure that you also enter a value for the createdDateTo parameter.
createdDateTo
Optional. To find categories created between a date range, enter the ending date.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the createdDateTo parameter, ensure that you also enter a value for the createdDateFrom parameter.
modifiedDateFrom
Optional. To find categories modified between a date range, enter the starting date.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the modifiedDateFrom parameter, ensure that you also enter a value for the modifiedDateTo parameter.
modifiedDateTo
Optional. To find categories modified between a date range, enter the ending date.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the modifiedDateTo parameter, ensure that you also enter a value for the modifiedDateFrom parameter.
sortByField
Optional. Specify the parameters to sort the search results.
To sort the search results, enter one of the following values:
  • - ID
  • - NAME
  • - STATUS
  • - CREATED_BY
  • - CREATED_ON
  • - MODIFIED_BY
  • - MODIFIED_ON
Default value is MODIFIED_ON.
sort
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.
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.
rootOnly
Optional. Specify whether to retrieve only the root category of a hierarchy.
Enter one of the following values:
  • - If you want to retrieve only the root category of a hierarchy and don't want the search results to contain subcategories, enter true.
  • - If you don't want to retrieve only the root category of a hierarchy and want the search results to contain subcategories, enter false.
Default value is false.
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/v1/integration/categories?status=ACTIVE

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 details of a category:

{
"processingTime": 369,
"offset": 0,
"limit": 50,
"totalCount": 186,
"objects": [
{
"id": "2fa40528-410d-4cf6-8ee3-9f3ef328285c",
"refId": "CAT-414",
"parentId": "g92b4h1e-3rc4-4444-318v-383135d296y6",
"name": "Retail Department",
"description": "This category represents the retail department.",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"hasChildCategory": false,
"dataOwners": [
{
"displayName": "cdmp_cat_owner_qa1607",
"id": "e9paNlaKR8MdFJnETEs2k4",
"name": "John Doe",
"email": "johndoe@informatica.com",
"phone": "8758939746",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"createdBy": "f400dUqjPuaiJ9KBrzOhiB",
"createdOn": "2022-07-20T10:49:53.505Z",
"modifiedBy": "f400dUqjPuaiJ9KBrzOhiB",
"modifiedOn": "2022-07-20T10:49:53.505Z"
}
]
}
The following table describes the parameters of each category that is retrieved:
Parameter
Description
offset
Starting index for paginated results.
limit
Maximum number of results.
totalCount
Number of categories retrieved.
id
System generated unique identifier of the category.
refId
Reference 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. A category can have one of the following statuses:
  • - ACTIVE
  • - INACTIVE
effectiveStatus
The effective status 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.
hasChildCategory
This parameter indicates whether a category has subcategories. This parameter can have one of the following values:
  • - true. The category contains subcategories.
  • - false. The category doesn't contain subcategories.
dataOwners
Details of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > displayName
Name of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > id
System generated unique identifier of the user account or user group that is assigned as a stakeholder on the category with the Category Owner stakeholder role.
dataOwners > name
Username of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > email
Email address of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > phone
Contact number of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > status
The status indicates whether or not the Category Owner stakeholder user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The Category Owner user account or user group is active.
  • - INACTIVE. The Category Owner user account or user group is not active.
dataOwners > userInfo
Details retrieved from the My Data page of the stakeholder that is assigned the Category Owner stakeholder role on the category.
dataOwners > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
createdBy
System generated identifier of the user account that created the category.
createdOn
Date when the category was created.
modifiedBy
System generated identifier of the latest user account that modified the category.
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/v1/integration/categories
Method
PUT

Request

The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
id
Required. The system generated unique identifier of the category that you want to modify.
For more information about how you can use an API to get the system generated unique identifier of a category, see Retrieve categories.
To get the system generated unique identifier of a category from the Data Marketplace 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.
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.
-
dataOwners
Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the category with the Category Owner stakeholder role.
  • - 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated 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 system generated unique identifier.
    • For example, in the URL /cloudUI/products/administer/main/userGroupsAsset/90uizkSWg0ycuu7hSNXSW4, the system generated unique identifier is 90uizkSWg0ycuu7hSNXSW4.

Example request

The following example shows how you can use an API to modify a category:
{
"items": [
{
"id": "2fa40528-410d-4cf6-8ee3-9f3ef328285c",
"name": "Retail Department",
"description": "This category represents the retail department.",
"dataOwners": [
"e9paNlaKR8MdFJnETEs2k4"
]
}
]
}

Response

When you pass the API payload 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 modify a category:

{
"processingTime": 10105,
"objects": [
{
"index": 1,
"id": "2fa40528-410d-4cf6-8ee3-9f3ef328285c",
"refId": "CAT-414",
"name": "Retail Department"
}
]
}

The following table describes the parameters of each category that is modified:
Parameter
Description
index
The position of the category in the objects JSON array. This value does not impact how the category is used by a Data Marketplace user.
id
System generated unique identifier of the category.
refId
Reference identifier of the category.
name
Name of the category.

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/v1/integration/categories/<id>
<id>: 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, 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.
For more information about how you can use an API to get the system generated unique identifier of a category, see Retrieve categories.
Method
DELETE
Note: You can call a maximum of 100 APIs per minute.

Request

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/v1/integration/categories/67417f72-e5ab-44f0-add9-a1e412c1ce13

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.
If you see the following response code, it means that the category is deleted successfully:
204 OK code