API Reference > 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/v1/integration/dataCollections/<dataCollectionId>/dataAssets
<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 data collections.
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.
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
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 example shows how you can use an API call to retrieve the data assets of a data collection:
https://{{CDMP_URL}}/api/v1/integration/dataCollections/794a215f-5479-4b55-8e1b-a4866ec9fe82/dataAssets

Response

When you pass the API query parameters in the REST client, the client displays a response for the request query based on the data collection that you specified.
The following example shows the response of an API call to retrieve the data assets of a data collection:

{
"processingTime": 212,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"name": "Accounts_Customers",
"id": "49d4856a-90b3-3584-abd6-47db0fe9acb6",
"refId": "DAS-191",
"description": "Customer Information",
"source": "CDLG",
"descriptiveSource": "AXON",
"type": "Table",
"refLink": "URL://AXON",
"assetLocation": "string",
"assetLocationDescription": "string",
"technicalAssetName": "string",
"status": "DISABLED",
"resourceReference": {
"typeReference": "string",
"sourceAssetId": "9u2rTIHJHpUgvriNoUUYsE"
},
"createdBy": "7w2uGIARApUgxniNoHHWsJ",
"createdOn": "2022-03-08T17:05:28.208Z",
"modifiedBy": "7w2uGIARApUgxniNoHHWsJ",
"modifiedOn": "2022-03-08T17:09:34.623Z"
}
]
}
The following table describes the parameters of each data asset that is retrieved:
Parameter
Description
offset
Starting index for the paginated results.
limit
Maximum number of results.
totalCount
Number of data assets retrieved.
name
Name of the data asset.
id
System generated unique identifier of the data asset.
refId
Reference identifier of the data asset.
description
Description 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.
type
Type of the data asset.
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.
status
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.
resourceReference
Details of the data asset that was imported from Data Governance and Catalog
resourceReference > typeReference
Type of the asset as defined in Data Governance and Catalog.
resourceReference > sourceAssetId
System generated unique identifier of the associated Data Governance and Catalog asset.
createdBy
System generated unique identifier of the user that created the data asset.
createdOn
Date when the data asset was created.
modifiedBy
System generated unique identifier of the latest user account that modified the data asset.
modifiedOn
Latest date when the data asset was modified.