Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AttributeUpdateResponse

Response of an individual attribute item in the bulk update attribute operation.

Properties

attributeName

attributeName: string

Attribute for which properties were updated in this bulk operation.

attributeNameSpace

attributeNameSpace: AttributeNameSpace

Namespace of the attribute whose properties were updated. The attributeNameSpace will default to TRACES if it is not passed in.

Optional attributeStatus

attributeStatus: AttributeStatus

Status of the attribute after this operation. The attribute can have one of the following statuses after the update operation. The attribute can have either a success status or an error status. The status of the attribute must be correlated with the operation status property in the bulk operation metadata object. The bulk operation will be successful only when all attributes in the bulk request are processed successfully and they get a success status back. The following are successful status values of individual attribute items in a bulk update attribute operation. ATTRIBUTE_UPDATED - The attribute's properites have been updated with the given properties. DUPLICATE_ATTRIBUTE - The attribute is a duplicate of an attribute that was present in this bulk request. Note that we deduplicate the attribute collection, process only unique attributes, and call out duplicates. A duplicate attribute in a bulk request will not prevent the processing of further attributes in the bulk operation. The following values are error statuses and the bulk processing is stopped when the first error is encountered. INVALID_ATTRIBUTE - The attribute is invalid. ATTRIBUTE_NOT_PROCESSED - The attribute was not processed, as there was another attribute in this bulk request collection that resulted in a processing error. ATTRIBUTE_DOES_NOT_EXIST - Attribute was neither active nor pinned inactive. ATTRIBUTE_UPDATE_NOT_ALLOWED - Attribute update is not allowed as it is an in-built system attribute.

Optional attributeType

attributeType: AttributeType

Type of the attribute.

Optional notes

notes: undefined | string

Notes for the attribute.

Optional operationType

operationType: OperationType

Type of operation - UPDATE_ATTRIBUTE_PROPERTIES.

timeUpdated

timeUpdated: Date

Time when the attribute's properties were updated.

Optional unit

unit: Unit

Unit updated for this attribute.

Functions

getDeserializedJsonObj

getJsonObj