Asset Attributes
Quick Navigation
- GET Assets/{assetID}/Attributes
- POST Assets/{assetID}/Attributes/{attributeID}
- DELETE Assets/{assetID}/Attributes
- DELETE Assets/{assetID}/Attributes/{attributeID}
GET Assets/{assetID}/Attributes
Purpose
Returns a list of attributes by Asset ID.
Required Permissions
Asset Management (Read), Attribute Management (Read).
URL Parameters
assetID: ID of the asset.
Request Body
None.
Response 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 }, … ]
Response Codes
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}
Purpose
Assigns an attribute to an asset.
Required Permissions
Asset Management (Read/Write), Attribute Management (Read/Write).
URL Parameters
- assetID: ID of the asset.
- attributeID: ID of the attribute Request Body.
Response 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, }
Response Codes
201 – Request successful. Attributes in the response body.
For more information, please see Common Response Codes.
DELETE Assets/{assetID}/Attributes
Purpose
Deletes all asset attributes by asset ID.
Required Permissions
Asset Management (Read/Write), Attribute Management (Read/Write).
URL Parameters
assetID: ID of the asset.
Request Body
None.
Response Body
None.
Response Codes
200 – Request successful.
For more information, please see Common Response Codes.
DELETE Assets/{assetID}/Attributes/{attributeID}
Purpose
Deletes an asset attribute by asset ID and attribute ID.
Required Permissions
- Asset Management (Read/Write).
- Attribute Management (Read/Write).
URL Parameters
assetID: ID of the asset attributeID and ID of the attribute.
Request Body
None.
Response Body
None.
Response Codes
200 – Request successful.
For more information, please see Common Response Codes.