Send a PATCH request to update business assets. You can also create and remove relationships between assets and enrich technical assets with business context.
Submit a request with the following method and endpoint. Specify the asset ID and the scheme of the asset that you want to update.
The base API URL differs for each pod. For more information, see Send Requests.
Request parameters
Enter the specific parameters in the URL to update assets and create or remove relationships between assets.
You can use the following request URL parameters to update assets.
Parameter
Description
assetID
The internal ID or the unique reference ID of the asset that you want to update.
scheme
Specify the type of asset ID value that you have entered in the assetID parameter. You can enter either internal ID or external ID to update 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.
Note: You can obtain the internal ID by looking at the URL of the asset page in the Data Governance and Catalog application.
- EXTERNAL. Indicates that the asset ID that you specify in the request is the unique reference ID of the asset.
Request body
Use the request body to specify the details of the update that you want to make for the asset. You can also update multiple segments for an asset.
In the body of the request, specify the parameters in the following format:
The following table describes the important parameters that you can specify in the body of the request:
Parameter
Type
Description
operation
String
Enter the following values:
- add
- remove
- replace
segment
Object
Specify the type of update that you want to make for the asset. The default value is segments=all. You can enter the following segment values such as: summary: Updates the name, description, and the location of the asset.
stakeholdership: Updates the stakeholder information.
data classification: Updates the data classification details.
parent: updates the parent details.
For more information about the properties of business assets, see the Understanding Business Assets help.
For more information about the properties of technical assets, see the Understanding Technical Assets help.
fromIdentity
String
If you want to create or remove a relationship between the asset and another asset, enter the source of the asset. This is the internal ID of the source asset.
fromExternalIdentity
String
If you want to create or remove a relationship between the asset and another asset, enter the source of the asset. This is the external ID of the source asset.
toIdentity
String
If you want to create or remove a relationship between the asset and another asset, enter the target ID of the asset. This is the internal ID of the target asset.
toExternalIdentity
String
If you want to create or remove a relationship between the asset and another asset, enter the target ID of the asset. This is the external ID of the target asset.
association
String
If you want to create or remove the relationship between the asset and other assets, specify the type of relationship.
Example requests
Create relationship
The following example shows the PATCH request to update an asset by creating an "is related to" relationship between two business terms.
The following example shows the PATCH request to add the description of a business term.
PATCH https://idmc-api.dm-us.informaticacloud.com/data360/content/v1/assets/TERM-48/?scheme=external Authorization: Bearer <jwt_token> Accept: application/json Content-Type: application/json Body [ { "operation": "add", "segment": "summary", "attributes": { "core.description": "A combination of account number and sort code that represents an individual's account within a particular financial institution." } } ]
Replace summary
The following example shows the PATCH request to replace the description of a business term.
PATCH https://idmc-api.dm-us.informaticacloud.com/data360/content/v1/assets/TERM-48/?scheme=external Authorization: Bearer <jwt_token> Accept: application/json Content-Type: application/json Body [ { "operation": "replace", "segment": "summary", "attributes": { "core.description": "A unique combination of an account number and sort code that identifies an individual's account at a specific financial institution." } } ]
Remove summary
The following example shows the PATCH request to remove the description of a business term.
PATCH https://idmc-api.dm-us.informaticacloud.com/data360/content/v1/assets/TERM-48/?scheme=external Authorization: Bearer <jwt_token> Accept: application/json Content-Type: application/json Body [ { "operation": "remove", "segment": "summary", "attributes": { "core.description": "A unique combination of an account number and sort code that identifies an individual's account at a specific financial institution" } } ]
Add asset properties
The following example shows the PATCH request to mark a business term as critical data element.