API Reference > Manage Data Marketplace content > Data assets
  

Data assets

A representation of data in an organization. Data assets may contain relevant data elements and are contained in one or more data collections.

Create data assets

Use a REST API to create data assets in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataAssets
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 data asset.
-
refId
Optional. Enter a reference identifier for the data asset.
If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the object. 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.
description
Required. Enter a description for the data asset.
-
source
Required. Specify the source system from which the data is supplied to Data Marketplace.
-
descriptiveSource
Optional. Specify the source application from which the description of the data asset is taken.
-
type
Required. Enter a type for the data asset.
-
refLink
Optional. Enter the uniform resource identifier of the location in the data source where the data asset is stored.
-
assetLocation
Optional. Enter the location of the data asset in the data source.
-
assetLocationDescription
Optional. Enter a description for the location in the data source where the data asset is stored.
-
technicalAssetName
Optional. Enter the name of the data asset as it appears in the data source.
-
status
Optional. Specify a status for the data asset. The status indicates whether the data asset is available to be added to data collections.
Enter one of the following values:
  • - To make the data asset available, enter ENABLED.
  • - To make the data asset unavailable, enter DISABLED.
Default value is ENABLED.

Example request

The following example shows how you can use an API to create a data asset:
{
"items": [
{
"name": "Accounts_Customers",
"refId": "CMDS001",
"description": "Customer Information",
"source": "CDLG",
"descriptiveSource": "AXON",
"type": "Table",
"refLink": "URL://AXON",
"assetLocation": "string",
"assetLocationDescription": "string",
"technicalAssetName": "string",
"status": "ENABLED"
}
}
]
}

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 data asset:
{
"processingTime": 2130,
"objects": [
{
"index": 1,
"id": "49d4856a-90b3-3584-abd6-47db0fe9acb6",
"refId": "CMDS001",
"name": "Accounts_Customers"
}
]
}
The following table describes the parameters of each data asset that is created:
Parameter
Description
index
The position of the data asset in the objects JSON array. This value does not impact how the data asset is used by a Data Marketplace user.
id
System generated unique identifier of the data asset.
refId
Reference identifier of the data asset.
name
Name of the data asset.

Retrieve data assets

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

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataAssets
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 a search term to find the data assets.
Ensure that the search term that you enter don't contain an asterisk (*).
fields
Optional. Enter one or more fields that apply to the search. The terms you enter in the search fields parameter are searched in the fields that you enter here.
Enter the following values:
  • - NAME
  • - DESCRIPTION
  • - SOURCE
  • - TYPE
  • - DESCRIPTIVE_SOURCE
createdDateFrom
Optional. To find data assets 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 data assets 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 data assets 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 data assets 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.
status
Optional. Specify the status of the data asset. The status indicates whether the data asset is available to be added to data collections.
Enter one of the following values:
  • - To find the data assets that are available, enter ENABLED.
  • - To find the data assets that aren't available, enter DISABLED.
sortByField
Optional. Specify the parameters to sort the search results.
To sort the search results, enter one of the following values:
  • - ID
  • - NAME
  • - SOURCE
  • - DESCRIPTIVE_SOURCE
  • - TYPE
  • - ASSET_LOCATION
  • - ASSET_LOCATION_DESCRIPTION
  • - TECHNICAL_ASSET_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.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of a data asset:
https://{{CDMP_URL}}/api/v1/integration/dataAssets?search=Accounts_Customers2&status=ENABLED

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 data asset:

{
"processingTime": 212,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"name": "Accounts_Customers2",
"id": "35d4856a-90b3-3584-abd6-47db0fe9acb7",
"refId": "DAS-891",
"description": "Customer Information",
"source": "CDLG",
"descriptiveSource": "AXON",
"type": "Table",
"refLink": "URL://AXON",
"assetLocation": "string",
"assetLocationDescription": "string",
"technicalAssetName": "string",
"status": "DISABLED",
"resourceReference": {
"typeReference": "string",
"sourceAssetId": "string"
},
"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.

Modify data assets

Use a REST API to modify data assets in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataAssets
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. Enter the system generated unique identifier of the data asset that you want to modify.
For more information about how you can use an API to get the system generated unique identifier of a data asset, see Retrieve data assets.
To get the system generated unique identifier of a data asset from the Data Marketplace interface, open the data asset. The data asset page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/dataAsset/8c4c2089-6c7e-4696-a8f6-44f87639d65c?dtn=Table_Profiling_AK_1676302415587&tab=dataElements, the system generated unique identifier is 8c4c2089-6c7e-4696-a8f6-44f87639d65c.
Note: You can use this API to modify only the data assets that are native to Data Marketplace. To modify a data asset that was imported from Data Governance and Catalog, see the Data Governance and Catalog help.
name
Required. Enter a name for the data asset.
-
description
Required. Enter a description for the data asset.
-
source
Required. Specify the source system from which the data is supplied to Data Marketplace.
-
descriptiveSource
Optional. Specify the source application from which the description of the data asset is taken.
-
type
Required. Enter a type for the data asset.
-
refLink
Optional. Enter the uniform resource identifier of the location in the data source where the data asset is stored.
-
assetLocation
Optional. Enter the location of the data asset in the data source.
-
assetLocationDescription
Optional. Enter a description for the location in the data source where the data asset is stored.
-
technicalAssetName
Optional. Enter the name of the data asset as it appears in the data source.
-
status
Optional. Specify a status for the data asset. The status indicates whether the data asset is available to be added to data collections.
Enter one of the following values:
  • - To make the data asset available, enter ENABLED.
  • - To make the data asset unavailable, enter DISABLED.
Default value is ENABLED.

Example request

The following example shows how you can use an API to modify a data asset:
{
"items": [
{
"id": "35d4856a-90b3-3584-abd6-47db0fe9acb7",
"name": "Accounts_Customers2",
"description": "Updated Customer Information",
"source": "CDLG",
"descriptiveSource": "AXON",
"type": "Table",
"refLink": "URL://AXON",
"assetLocation": "string",
"assetLocationDescription": "string",
"technicalAssetName": "string",
"status": "DISABLED"
}
]
}

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 data asset:
{
"processingTime": 2130,
"objects": [
{
"index": 1,
"id": "35d4856a-90b3-3584-abd6-47db0fe9acb7",
"refId": "DAS-891",
"name": "Accounts_Customers2"
}
]
}
The following table describes the parameters of each data asset that is modified:
Parameter
Description
index
The position of the data asset in the objects JSON array. This value does not impact how the data asset is used by a Data Marketplace user.
id
System generated unique identifier of the data asset.
refId
Reference identifier of the data asset.
name
Name of the data asset.

Delete data assets

Use a REST API to delete data assets in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/dataAssets/<id>
<id>: Required. Enter the system generated unique identifier of the data asset that you want to delete.
For more information about how you can use an API to get the system generated unique identifier of a data asset, see Retrieve data assets.
To get the system generated unique identifier of a data asset from the Data Marketplace interface, open the data asset. The data asset page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/dataAsset/8c4c2089-6c7e-4696-a8f6-44f87639d65c?dtn=Table_Profiling_AK_1676302415587&tab=dataElements, the system generated unique identifier is 8c4c2089-6c7e-4696-a8f6-44f87639d65c.
Method
DELETE

Request

The API has no payload.

Example request

The following example shows how you can use an API to delete a data asset:
https://{{CDMP_URL}}/api/v1/integration/dataAssets/d2313aed-330e-44a0-bcfa-380ee4a95a62

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 data asset is deleted successfully:
204 OK code