Names and unique names in workflows

In Collibra Data Intelligence Cloud version 5.4 or newer, there is a significant API change with regards to asset names. From this version onwards, assets have names and unique full names, respectively referred to as displayName and name in the API . In older versions, you only had name to refer to the asset name.

Action via API

Behavior
Add asset

When you add an asset via an API call, you can enter a name and displayName.

  • name: This is the unique full name of the asset and is represented by Full name in the UI.
  • displayName: This value of this argument is used as Name in the UI.

If you don't use the displayName argument when adding an asset via an API call, the displayName will automatically get the value of the name argument.
Update asset

The same arguments, name and displayName, can be used to update an asset, but you have to explicitly use the displayName argument to change its value.

The update will not overwrite the displayName value if you don't use displayName argument in the API call.

Example

The following example shows how you can change the asset name in Collibra Data Intelligence Cloud 5.3 or older and 5.4 or newer, both using API v2.

Note 
  • It is no longer recommended to use API v1.
  • After an upgrade to 5.4 or newer, verify workflows that affect asset names, with the new APIs.

5.3 or older

5.4 or newer

 
assetApi.changeAsset(builders.get("ChangeAssetRequest")

	.id(UUID assetUUID)

	.name(String newAssetName)

	.build())
 
assetApi.changeAsset(builders.get("ChangeAssetRequest")

	.id(UUID assetUUID)

	.name(String newAssetFullName)

	.displayName(String newAssetDisplayName)

	.build())