API Reference > Manage assets > Update assets
  

Update assets

Send a PATCH request to update business assets including business term, domain, metric, subdomain, process, policy, system, and data set. You can also enrich technical assets with business context.
Submit a request with the following method and endpoint. Specify the asset ID of the asset you want to update and the scheme.
Method
Endpoint
PATCH
<baseApiUrl>/data360/content/v1/assets/<assetID>?scheme=<EXTERNAL/INTERNAL>
Use the following parameters in the request URL:
Parameter
Description
IDENTITY
The internal ID or the unique reference ID of the asset you want to update.
scheme
Specify the type of asset ID you want to use to update the asset. 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.
  • Note: You can obtain the core.identity ID by checking the user details in the search API. You can enter either internal ID or external ID to update assets. For more information on the search API, see Search for assets.
The base API URL differs for each pod. For more information, see Send Requests.

Request body

Use the request body to specify the details of the asset update that you want to make.
In the body of the request, specify the parameters in the following format:

[
{
"operation": "add",
"segment": "summary",
"attributes": {
"core.description": "This is a table"
}
}
]
The following table describes the important parameters that you can specify in the body of the request:
Parameter
Type
Description
operation
String
Enter the values add, remove or replace.
segment
Object
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:
summary: Returns the name, description, and the location of the asset.
stakeholdership: Returns the stakeholder information.
data classification: Returns the data classification details.
parent: Returns the parent details.
glossary: Returns the glossary details.
self attributes: Returns the properties of the asset.
core.identity: The internal ID of the asset. You can obtain this ID by looking at the URL of the asset page in Data Governance and Catalog.
core.externalid: The unique reference ID of the asset.
core.role: Specify the stakeholder role details.
core.curationstatus
ACCEPTED: Data classifications that are in the accepted state.
REJECTED: Data classifications that are in rejected state.
For more information about the properties of business assets, see the Understanding Business Assests help.
For more information about the properties of technical assets, see the Understanding Technical Assests help.

Example requests

Add summary

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.
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": "selfAttributes",
"attributes": {
"com.infa.ccgf.models.governance.isCDE": true
}
}
]

Add custom attributes

The following example shows the PATCH request to add a custom attribute value to an asset
PATCH https://idmc-api.dm-us.informaticacloud.com/data360/content/v1/assets/TERM-48/?scheme=external
Authorization: Bearer <jwt_token>
Accept: application/json[
{
"operation": "add",
"segment": "customAttributes",
"attributes": {
"com.infa.odin.models.custom.ca_6004001966368974780": "My Custom Attribute Value"
}
}
]

Replace parent

The following example shows the PATCH request to replace the parent of an asset.
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",
"attributes": {
"parent": {
"core.externalId": "BTwithParent 1682"
}
}
}
]

Add stakeholder

The following example shows the PATCH request to add a stakeholder to an existing asset.
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": "stakeholdership",
"items": [
{
"core.identity": "4dc44acf-599a-32ec-9796-690f0a990069",
"core.role": [
"lVhW8Etrr2Xh1j30320u40"
]
}
]
}
]

Replace stakeholder

The following example shows the PATCH request to replace a the existing stakeholder of an asset with another stakeholder.
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": "stakeholdership",
"items": [
{
"core.identity": "4dc44acf-599a-32ec-9796-690f0a990069",
"core.role": [
"lVhW8Etrr2Xh1j30320u40"
]
}
]
}
]

Add glossary

The following example shows the PATCH request to add a glossary.
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": "glossary",
"items": [
{
"core.identity": "8d41f699-5ddf-45c7-a11d-f5462791a50c"
},
{
"core.externalId": "BTwithParent 1693",
"core.curationStatus": "ACCEPTED"
}
]
}
]

Replace glossary

The following example shows the PATCH request to replace a glossary.
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": "glossary",
"attributes": {
"core.externalId": "BTwithParent 1693",
"core.curationStatus": "REJECTED"
}
}
]

Remove glossary

The following example shows the PATCH request to remove a glossary.
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": "glossary",
"items": [
{
"core.identity": "8d41f699-5ddf-45c7-a11d-f5462791a50c"
}
]
}
]

Add data classification

The following example shows the PATCH request to add a data classification.
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": "dataClassification",
"items": [
{
"core.externalId": "8397ebd1-228d-4ad8-9baa-41cfb672b167",
"core.curationStatus": "ACCEPTED"
},
{
"core.externalId": "5491a201-8f65-4f17-bb0f-7f6205c44e4c"
},
{
"core.externalId": "c1c46611-5245-4cab-b5c4-07d77a708413"
}
]
}
]

Replace data classification

The following example shows the PATCH request to replace a data classification.
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": "dataClassification",
"items": [
{
"core.externalId": "8397ebd1-228d-4ad8-9baa-41cfb672b167",
"core.curationStatus": "ACCEPTED"
}
]
}
]

Update multiple segments

The folllowing example shows the PATCH request to update mutiple segments to an asset.
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 pair of account number and sort code that identifies an individual’s account at a specific bank."
}
},
{
"operation": "add",
"segment": "selfAttributes",
"attributes": {
"com.infa.ccgf.models.governance.AliasNames": [
"Account Number",
"Automation"
],
"com.infa.ccgf.models.governance.isCDE": true
}
}
]