API Reference > Manage data collections > Retrieve data collections
  

Retrieve data collections

Use REST APIs to retrieve the details of data collections in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataCollections
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 data collection.
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 data collection.
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.
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 data collection with the Data 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.
technicalOwners
Optional. Enter the system generated unique identifier of the user account or user group that is assigned as a stakeholder on the data collection with the Technical 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.
categoryIds
Optional. Enter the system generated unique identifier of the category that contains the data collection.
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.
usageContextIds
Optional. Enter the system generated unique identifier of the usage type that is used to specify the certified use of the data collection.
For more information about how you can use an API to get the system generated unique identifier of a usage type, see Retrieve usage type.
deliveryTemplateIds
Optional. Enter the system generated unique identifier of the delivery template that was used to create the delivery target of the data collection.
For more information about how you can use an API to get the system generated unique identifier of a delivery template, see Retrieve delivery templates.
deliveryTargetLocations
Optional. Specify the delivery target location.
-
createdDateFrom
Optional. To find data collections that were created between a date range, enter the initial date when the data collections were created.
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 data collections that were created between a date range, enter the latest date when the data collections were created.
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 data collections that were modified between a date range, enter the initial date when the data collections were modified.
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 data collections that were modified between a date range, enter the latest date when the data collections were modified.
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.
status
Optional. Specify the status of the data collection. The status indicates whether or not the data collection is available to Data Users.
Enter one of the following values:
  • - To find the data collections that are discoverable to Data Users, enter PUBLISHED.
  • - To find the data collections that aren't discoverable to Data Users, enter UNPUBLISHED.
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.
You can sort the search results in the following order:
  • - 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.
Note: The API has no payload.

Example request

The following examples show how you can use APIs to retrieve the details of data collections:
Example request 1
https://{{CDMP_URL}}/api/v1/integration/dataCollections?ids=675c2d4d-f0a8-4526-9aeb-304c86488296&usageContextIds=IdString2&sortByField=MODIFIED_ON&sort=DESC'
Example request 2
https://{{CDMP_URL}}/api/v1/integration/dataCollections?ids=0537c392-a359-4cdc-8989-1d88eee1dddb

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 examples show the response of API calls to retrieve the details of data collections:
Example response 1

{
"processingTime": 5177,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"id": "b90626e0-c9ae-44ed-b9ed-67178e92e886",
"refId": "DCL-945",
"name": "Retail Outlet List",
"description": "List of all retail outlets.",
"category": {
"id": "8a17c0c2-dc9b-4904-8d28-535c27f23489",
"name": "Retail",
"description": "The category for the Retail department.",
"refId": "CAT-744",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE"
},
"usageContexts": [
{
"id": "675c2d4d-f0a8-4526-9aeb-304c86488296",
"name": "Retail Analytics",
"description": "This is for analytics purposes by the retail department.",
"color": "string",
"status": "ACTIVE"
}
],
"status": "PUBLISHED",
"dataOwners": [
{
"displayName": "Jane Doe",
"id": " User1",
"name": "username1",
"email": "abc@xyz.com",
"phone": "2020202020",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"technicalOwners": [
{
"displayName": "John Doe",
"id": "User2",
"name": "username2",
"email": "xyz@abc.com",
"phone": "2020202021",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"customFields": [
{
"name":"com.infa.odin.models.custom.ca_1007408542741800522",
"value":"false",
"values":null
}
],
"createdBy": "lWDKqZAREESgsDTtk9kVOy",
"createdOn": "2022-06-21T10:43:03.374Z",
"modifiedBy": "lWDKqZAREESgsDTtk9kVOy",
"modifiedOn": "2022-07-07T13:26:23.180Z"
}
]
}
Example response 2

{
"processingTime": 7788,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"id": "0537c392-a359-4cdc-8989-1d88eee1dddb",
"refId": "78901",
"name": "08/09 J-SOX Reports",
"description": "The collection of J-SOX reports from 2008-09.",
"category":
{
"id": "5e056b9b-d2d1-4b33-a38b-3d8255cde7c0",
"name": "cat05",
"description": "desc",
"refId": "16",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE"
},
"usageContexts": null,
"status": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"customFields": [
{
"name": com.infa.odin.models.custom.ca_3184028726397751640",
"value": "2023-09-05",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_3068304325528979652",
"value": null,
"values": [
{
"Apache CloduStack",
"Microsoft Azure" ]
},
{
"name": "com.infa.odin.models.custom.ca_8610145587620226269",
"value": "Reticulum",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_6928840635020975219",
"value": "45.6",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_5588843841075376340",
"value": "LXMF",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_7907323524500803261",
"value": "Secure Data Transfer",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_1535512762047882544",
"value": "10",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_1007408542741800522",
"value": "false",
"values": null
},
{
"name": "com.infa.odin.models.custom.ca_7821688086685433570",
"value": "false",
"values": null
}
],
"createdBy": "8lgIca73QzfdX7xzhZnOQa",
"createdOn": "2023-09-11T05: 40: 34.460Z",
"modifiedBy": "8lgIca73QzfdX7xzhZnOQa",
"modifiedOn": "2023-09-11T05: 40: 34.460Z"
}
]
}

The following table describes the parameters of each data collection that is retrieved:
Parameter
Description
processingTime
Time taken (in milliseconds) to complete the API call.
offset
Starting index for the paginated results.
limit
Maximum number of results.
totalCount
Number of data collections retrieved.
objects
Details of the retrieved data collection.
id
System generated unique identifier of the data collection.
refId
Reference identifier of the data collection.
name
Name of the data collection.
description
Description of the data collection.
category
Details of the category that contains the data collection.
category > id
System generated unique identifier of the category that contains the category.
category > name
Name of the category that contains the category.
category > description
Description of the category that contains the category.
category > status
Status of the category. A category can have one of the following statuses:
  • - ACTIVE
  • - INACTIVE
category > 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.
usageContexts > id
System generated unique identifier of the usage type that is used to specify the certified use of the data collection.
usageContexts > name
Name of the usage type that is used to specify the certified use of the data collection.
usageContexts > description
Description of the usage type that is used to specify the certified use of the data collection.
usageContexts > color
A hexadecimal value that represents the color indicator of the usage type. Assigning a unique color indicator allows Data Marketplace users to identify a usage type easily.
usageContexts > status
The status indicates whether a usage type is available to be added to a data collection or to be selectable on an order. A usage type can have one of the following values:
  • - ACTIVE. The usage type is available.
  • - INACTIVE. The usage type is available.
status
The status indicates whether the data collection is discoverable by Data Users when they search for it. A data collection can have one of the following statuses:
  • - PUBLISHED. The data collection is discoverable to Data Users.
  • - UNPUBLISHED. The data collection isn't discoverable to Data Users.
dataOwners
Details of the stakeholder that is assigned the Data Owner stakeholder role on the data collection.
dataOwners > displayName
Name of the stakeholder that is assigned the Data Owner stakeholder role on the data collection.
dataOwners > id
System generated unique identifier of the user account or user group that is assigned as a stakeholder on the data collection with the Data Owner stakeholder role.
dataOwners > name
Username of the stakeholder that is assigned the Data Owner stakeholder role on the data collection.
dataOwners > email
Email address of the stakeholder that is assigned the Data Owner stakeholder role on the data collection.
dataOwners > phone
Contact number of the stakeholder that is assigned the Data Owner stakeholder role on the data collection.
dataOwners > status
The status indicates whether or not the Data Owner stakeholder user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The Data Owner user account or user group is active.
  • - INACTIVE. The Data 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 Data Owner stakeholder role on the data collection.
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
technicalOwners
Details of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > displayName
Name of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > id
System generated unique identifier of the user account or user group that is assigned as a stakeholder on the data collection with the Technical Owner stakeholder role.
technicalOwners > name
Username of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > email
Email address of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > phone
Contact number of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > status
The status indicates whether or not the Technical Owner stakeholder user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The Technical Owner user account or user group is active.
  • - INACTIVE. The Technical Owner user account or user group is not active.
technicalOwners > userInfo
Details retrieved from the My Data page of the stakeholder that is assigned the Technical Owner stakeholder role on the data collection.
technicalOwners > 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
customFields
The values entered in the custom fields as specified by a stakeholder of the data collection.
Custom fields are additional properties for Data Marketplace objects that are defined by your Administrator in Metadata Command Center.
For more information about custom fields, see the Create custom attributes for objects topic in the Set Up Data Marketplace help.
customFields > name
The system generated unique identifier of the custom field.
For more information about how you can retrieve the custom field name as it appears on the Data Marketplace interface, see Retrieve custom fields.
customFields > value
The custom field value. This parameter can have only a single value.
customFields > values
The custom field value. This parameter can have multiple values.
createdBy
System generated unique identifier of the user account that created the data collection.
createdOn
Date when the data collection was created.
modifiedBy
System generated unique identifier of the latest user account that modified the data collection.
modifiedOn
Latest date when the data collection was modified.