Update Logical Asset¶

Update all or selected details of a logical asset.

Operation Permissions¶

Before invoking this API, ensure that the application has been authorized the permission to invoke this API. For how to authorize the application, see Getting API Calling Permissions.

Prerequisite¶

The logical asset to be updated must exist.
The selected details to be updated must exist.

Request Format¶

POST https://{apigw-address}/asset-service/v2.1/logical-assets?action=update

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>
isPatchUpdate	Query	Optional	Boolean	`true` (default): Only the fields specified in the parameters are updated. The values of those fields not specified will be retained. `false`: The fields specified in the parameters are updated. Those fields not specified will have their existing values (if any) deleted. Note that `timezone` and `name` need to be specified when `isPatchUpdate` is `false`.

Request Parameters (Body)¶

Name

Mandatory/Optional

Data Type

Description

assetUpdateVo

Mandatory

AssetUpdateVo Struct

Used for asset update.

When isPatchUpdate is true, only the fields specified in the parameters are updated. The values of those fields not specified will be retained.
When isPatchUpdate is false, the fields specified in the parameters are updated. Those fields not specified will have their existing values (if any) deleted.

For more information, see AssetUpdateVo Struct.

AssetUpdateVo Struct ¶

Name	Mandatory/Optional	Data Type	Description
assetId	Mandatory	String	The asset ID. How to get assetId>>
name	Optional	StringI18n	Specify the asset’s name in its respective locale’s language. For more details on the structure and locales supported, see Internationalized name struct.
description	Optional	String	The asset description.
attributes	if `isPatchUpdate` is `false` , this is mandatory, and must include all the attributes prescribed in the model feature definition and their values. if `isPatchUpdate` is `true` , this is optional, and can include all or part of the attributes prescribed in the model feature definition and their values. The values can be left blank.	Map (Key is of String type, and Value depends on the attribute defined in the model)	Attributes of the model which the asset belongs to. Key is the attribute ID. For more information, see attributes representation.
timezone	Optional	String	The timezone where the asset is located. Use the “+08:00” format for time zones that do not support Daylight Saving Time (DST). Use the “Asia/Shanghai” format for time zones that support DST. For details, see Timezone representation.
tags	Optional	Map (Key and Value are of String type)	User-defined tags. For more information, see How to use tag.

Error Codes¶

Code	Message	Description
17404	Logical asset does not exist	The `assetId` cannot be found or does not exist.
17958	Asset validation failed	Failed to verify assets based on model.

Samples¶

Request Sample¶

url: https://{apigw-address}/asset-service/v2.1/logical-asset?action=update&orgId=yourOrgId&isPatchUpdate=true
method: POST
requestBody:
{
    "assetUpdateVo":{
        "assetId":"yourAssetId",
        "name":{
            "defaultValue":"instanceName",
            "i18nValue":{
                "en_US":"English name ",
                "zh_CN":"Chinese name"
            }
        },
        "description":"description",
        "attributes":{
      "color": "blue",
      "number": 135
        },
        "timezone":"+08:00",
        "tags":{
            "year":"2000",
            "author":"authorName"
        }
    }
}

Return Sample¶

{
 "code": 0,
 "msg": "OK",
 "requestId": "fa11232e-7e45-4176-a382-963c1240a27f"
}

SDK Samples¶

You can access the SDK samples for Asset Service on GitHub:

Java
Python