Asset Attributes

Quick Navigation

GET Assets/{assetID}/Attributes

Returns a list of attributes by Asset ID.

Asset Management (Read), Attribute Management (Read)

assetID: ID of the Asset.

None

Content-Type: application/json

[
    {
        AttributeID : int, AttributeTypeID : int,
        ParentAttributeID : int, // can be null
        ShortName : string,
        LongName : string,
        Description : string,
        ValueInt : int, // can be null
        IsReadOnly: bool
    },
    …
]

200 – Request successful. Attributes associated with the Asset in the response body.

For more information, please see Common Response Codes.

POST Assets/{assetID}/Attributes/{attributeID}

Assigns an attribute to an Asset.

Asset Management (Read/Write), Attribute Management (Read/Write)

  • assetID: ID of the asset.
  • attributeID: ID of the attribute Request Body.

Content-Type: application/json

{
    AttributeID : int, AttributeTypeID : int,
    ParentAttributeID : int, // can be null
    ShortName : string,
    LongName : string,
    Description : string,
    ValueInt : int, // can be null
    IsReadOnly: bool,
}

201 – Request successful. Attributes in the response body.

For more information, please see Common Response Codes.

DELETE Assets/{assetID}/Attributes

Deletes all asset attributes by Asset ID.

Asset Management (Read/Write), Attribute Management (Read/Write)

assetID: ID of the Asset.

None

None

200 – Request successful.

For more information, please see Common Response Codes.

DELETE Assets/{assetID}/Attributes/{attributeID}

Deletes an asset attribute by Asset ID and Attribute ID.

  • Asset Management (Read/Write)
  • Attribute Management (Read/Write)

assetID: ID of the Asset attributeID and ID of the Attribute.

None

None

200 – Request successful.

For more information, please see Common Response Codes.