List details of multiple assets Send a POST request to view the details of multiple assets in the catalog. While sending the request, you can specify the reference IDs of one or more assets in the body of the request. In the request parameters, specify the type of asset details that you would like to view.
To list the details of multiple assets, submit a request with the following method and endpoint, and specify the asset ID:
Method
Endpoint
POST
<baseApiUrl>/data360/search/v1/assets/details
The
<baseApiUrl> differs for each pod. For more information about the base API URL, see
Send Requests .
Request parameters In the request URL parameters, specify the type of asset ID that you want to use to search for assets. To limit the API response to specific details of an asset, you can additionally specify the type of asset details that you want the request to return.
Use the following parameters in the request URL:
Parameter
Description
scheme
Specify the type of asset ID you want to use to query assets. Enter one of the following values:
- internal . Indicates that the asset ID that you specify in the request is the internal ID of the asset.- external . Indicates that the asset ID that you specify in the request is the unique reference ID of the asset.segments
Specify the type of asset details that you want the API request to return. The default value is segments=all .Enter any segment value from the following values:
- all . Returns the internal ID, external ID, summary, system attributes, and the API request link to view further details of the asset.- summary . Returns the name, description, and location of the asset.- systemAttributes . Returns the origin, class type, base types, user that created or updated the asset and the date on which the asset was created or updated.- stakeholdership . Returns the type of user and role that are assigned as stakeholder for the asset.- customAttributes . Returns the custom attributes specified for the asset.- selfAttributes . Returns the properties of assets.- dataProfile . Returns the profiling statistics of the asset.- dataClassification . Returns the data classification associated with the asset.- glossary . Returns the glossary associated with the asset.- dataQuality . Returns the data quality score of the asset.- hierarchy . Returns the immediate child assets of the asset.- hierarchy:all . Returns all the attributes of the immediate child assets in the hierarchy.- hierarchy:selfAttributes . Returns the properties of the immediate child assets in the hierarchy.- hierarchy:systemAttributes . Returns the system attributes of the immediate child assets in the hierarchy.- hierarchy:customAttributes . Returns the custom attributes of the immediate assets in the hierarchy.- neighborhood . Returns assets that are in a direct relationship with the searched asset. - neighborhood:all . Returns assets that are in a direct or indirect relationship with the searched asset. - neighborhood:<classtype> . Returns assets of the specified class type that are in a direct relationship with the searched asset. - lineage-level . Returns the lineage level of the asset, that is data element or data set level. The default value for lineage-level is dataset .- lineage-direction . Returns the direction of the asset in the lineage, that is inbound or outbound. The default value for lineage-direction is all .- lineage-level:dataset . Returns assets that have a direct relationship with the searched asset. - lineage-direction:all . Returns assets that are in a direct inbound and outbound relationship with the searched asset. - lineage-direction:inbound . Returns assets that are in a direct inbound relationship with the searched asset. - lineage-direction:outbound . Returns assets that are in a direct outbound relationship with the searched asset. - descendants . Returns the immediate children and related child assets.- descendants:all . Returns all the details of the immediate and related child assets.- descendants:systemAttributes . Returns the system attributes of the immediate and related child assets.- descendants:selfAttributes . Returns the properties of the immediate and related child assets.- descendants:customAttributes . Returns the custom attributes of the immediate and related child assets.
Request body Use the request body to specify the external or internal IDs of assets that you want to view. You can specify in the scheme request parameter whether you want to search the asset by external ID or internal ID.
In the body of each API request, specify up to five comma-separated asset IDs. You can specify the asset IDs in the following format:
[
If you don't know the ID of a particular asset, you can first send a POST request to view the list of assets in the catalog. This request returns the internal ID of each asset in the
core.identity parameter and the unique reference ID of the asset in the
core.externalId parameter. For more information, see
List assets in the catalog .
Example request Search for two assets using internal asset IDs The following example shows the POST request to list all the details of a column and an associated business term by passing the internal IDs of both the assets in the request body.
POST https://idmc-api.dm-us.informaticacloud.com/data360/search/v1/assets/details?scheme=internal&segments=all
The following example shows the response for the request. The response returns all the details of the business term 'AddressLine2' and the column 'CDGCTABL31COL2' because the segments parameter in the request is set to all .
[summary ": {systemAttributes ": {customAttributes ": {selfAttributes ": {neighborhood ": [summary ": {systemAttributes ": {selfAttributes ": {dataProfile ": {glossary ": [neighborhood ": [lineage ": [