NEnetxms
Asset Management Schema

Update an asset attribute

Changed on

Update an existing asset attribute definition. Only the fields present in the request body are modified (merge-patch semantics); the attribute name itself cannot be changed. Requires "Manage asset management schema" system access right.

put/v1/asset-management-schema/{attribute-name}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/asset-management-schema/{attribute-name}
  • Auth
    HTTP bearer

Path parameters

attribute-namestring required

Asset attribute name.

Request body

namestring required

Unique attribute name. Must match the pattern ^[A-Za-z$][A-Za-z0-9$]*$. Immutable after creation.

displayNamestring

Human-readable display name.

dataType'String' | 'Integer' | 'Number' | 'Boolean' | 'Enum' | 'MacAddress' | 'IPAddress' | 'UUID' | 'ObjectReference' | 'Date'

Attribute data type. Accepts the symbolic name (or, for backward compatibility, the numeric code) on input; always returned as the symbolic name.

isMandatoryboolean

Whether a value for this attribute is mandatory on assets.

isUniqueboolean

Whether the attribute value must be unique across all assets.

isHiddenboolean

Whether the attribute is hidden in the UI.

autofillScriptstring

NXSL script used to automatically populate the attribute value.

rangeMininteger

Minimum value (for numeric types) or minimum length (for strings). 0 means unset.

rangeMaxinteger

Maximum value (for numeric types) or maximum length (for strings). 0 means unset.

systemType'None' | 'Serial' | 'IPAddress' | 'MacAddress' | 'Vendor' | 'Model'

System type binding for the attribute. Accepts the symbolic name (or the numeric code) on input; always returned as the symbolic name.

enumMapobject

For the Enum data type, the map of allowed values to their display names.

Response

Asset attribute updated successfully.

namestring required

Unique attribute name. Must match the pattern ^[A-Za-z$][A-Za-z0-9$]*$. Immutable after creation.

displayNamestring

Human-readable display name.

dataType'String' | 'Integer' | 'Number' | 'Boolean' | 'Enum' | 'MacAddress' | 'IPAddress' | 'UUID' | 'ObjectReference' | 'Date'

Attribute data type. Accepts the symbolic name (or, for backward compatibility, the numeric code) on input; always returned as the symbolic name.

isMandatoryboolean

Whether a value for this attribute is mandatory on assets.

isUniqueboolean

Whether the attribute value must be unique across all assets.

isHiddenboolean

Whether the attribute is hidden in the UI.

autofillScriptstring

NXSL script used to automatically populate the attribute value.

rangeMininteger

Minimum value (for numeric types) or minimum length (for strings). 0 means unset.

rangeMaxinteger

Maximum value (for numeric types) or maximum length (for strings). 0 means unset.

systemType'None' | 'Serial' | 'IPAddress' | 'MacAddress' | 'Vendor' | 'Model'

System type binding for the attribute. Accepts the symbolic name (or the numeric code) on input; always returned as the symbolic name.

enumMapobject

For the Enum data type, the map of allowed values to their display names.

Changes