API Reference > Part II: Authenticate using JWT > Manage data collections > Retrieve the data assets of a data collection
  

Retrieve the data assets of a data collection

Use a REST API to retrieve the data assets of a data collection.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/data-collections/<dataCollectionId>/data-assets
<dataCollectionId>: Required. Enter the system-generated unique identifier of the data collection for which you want to retrieve the data assets.
For more information about how you can use an API to get the system-generated unique identifier of a data collection, see Retrieve all data collections.
To get the system-generated unique identifier of a data collection from the Data Marketplace user 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
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
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.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of the data assets that are associated with a data collection:
https://{{CDMP_URL}}/api/v2/data-collections/2593524d-82f7-4dfd-bc6b-17088c046f9d/data-assets

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 the data assets that are associated with a data collection:
{
"pageInfo": {
"offset": 40,
"limit": 20,
"totalCount": 150
},
"links": {
"self": {
"href": "/data-collections/{dataCollectionId}/data-assets?offset=40&limit=20"
},
"first": {
"href": "/data-collections/{dataCollectionId}/data-assets?offset=0&limit=20"
},
"next": {
"href": "/data-collections/{dataCollectionId}/data-assets?offset=60&limit=20"
},
"previous": {
"href": "/data-collections/{dataCollectionId}/data-assets?offset=20&limit=20"
},
"last": {
"href": "/data-collections/{dataCollectionId}/data-assets?offset=140&limit=20"
}
},
"items": [
{
"id": "2593524d-82f7-4dfd-bc6b-17088c046f9d",
"externalId": "DAS-1",
"name": "NA Sales Data",
"description": "Data related to sales made in the 'North America' region.",
"status": "ENABLED",
"type": "Table",
"source": "Snowflake",
"descriptiveSource": "CDGC",
"refLink": "www.snowflake.provisioning/datashare56",
"assetLocation": "Snowflake",
"assetLocationDescription": "Sales data for NA region stored in Snowflake DB of respective Data Center",
"technicalAssetName": "NA Sales Data",
"averageRating": 4.5
}
]
}
The following table describes the parameters of each data asset 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 data assets 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.
id
System-generated unique identifier of the data asset.
externalId
Reference identifier of the data asset.
name
Name of the data asset.
description
Description of the data asset.
status
Status of the data asset. The status indicates whether the data asset is available to be added to data collections.
A data asset can have one of the following statuses:
  • - ENABLED. The data asset is available.
  • - DISABLED. The data asset isn't available.
type
Type of the data asset.
source
Source system from which the data is supplied to Data Marketplace.
descriptiveSource
Source application from which the description of the data asset is taken.
refLink
Uniform resource identifier of the location in the data source where the data asset is stored.
assetLocation
Location of the data asset in the data source.
assetLocationDescription
Description of the location in the data source where the data asset is stored.
technicalAssetName
Name of the data asset as it appears in the data source.
averageRating
If the asset is imported from Data Governance and Catalog into Data Marketplace, the system also retrieves its rating. A rating in Data Governance and Catalog represents a user's assessment of an asset. Data Governance and Catalog users rate assets between one to five stars. The value that you see is the average of the ratings provided by all the Data Governance and Catalog users. You can refer to the rating of a Data Governance and Catalog asset to gauge its reliability.