API Referenceuoms

Update UOM

Beta
Updates a Unit of Measurement.

Headers

AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The Unit of Measurement (UOM)'s DON.
aggregation_typeenumOptional
Aggregation type to be used while aggregating the metering data for the UOM. 1] Sum - sum of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max of all the values for the meter in a given period Ex. { M1:2, M1:4 } => {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for the meter in the given period (not considering the data from the previous billing period) Ex. January {M1:{VM:VM0}}, February {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total - Sum of distinct active unique dimension observed for a meter in the given period, taking into consideration the active data from the previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off} February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3} 6] Duration - Sum of distinct active unique dimension duration for a meter in the given period, taking into consideration the active data from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15 {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1-> 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the latest/last meter in the given period 8] Oldest - consider the oldest/first record in the given period.
descriptionstringOptionalformat: "text"
Description of the Unit of Measurement (UOM).
dimensionsobjectOptional
is_enabledbooleanOptional
Flag used to enable/disable the Unit of Measurement (UOM). When disabled, any metricsrecords ingested against this UOM will be dropped.
namestringOptionalformat: "text"
Human readable name of the Unit of Measurement (UOM).
part_idstringOptionalformat: "id"
The part ID such as feature or capability for which the Unit of Measurement (UOM) is defined.
product_idstringOptionalformat: "id"
The product ID for which the Unit of Measurement (UOM) is defined.
unitstringOptionalformat: "text"
Unit name of the Unit of Measurement (UOM).

Response

Success.
uomobject

Errors