Assets | Meter
Service to manage entities of type 'Meter'.
Overview
URL | api/{tenantKey}/{orgKey}/assetManagementCore/meters |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute Meter
- PUT Set IsActive Meter
- PUT Set MeterKey Meter
- PUT Set Description Meter
- PUT Set MeterType Meter
- PUT Set Unit Meter
- PUT Set LocationFunction Meter
- PUT Set Family Meter
- PUT Set Brand Meter
- PUT Set BrandModel Meter
- PUT Set AssetType Meter
- PUT Set Location Meter
- PUT Set Equipment Meter
- PUT Set Tool Meter
- PUT Set ParentMeter Meter
- PUT Set UnitCost Meter
- PUT Set Currency Meter
- PUT Set AverageCalculationMethod Meter
- PUT Set SlidingWindowSize Meter
- PUT Set StartValue Meter
- PUT Set MaxValue Meter
- PUT Set Remarks Meter
- PUT Set Company Meter
- PUT Set Serial Meter
- PUT Set LocationParentLocationHistoryId Meter
- PUT Set FromApi Meter
- PUT Set Characteristic MeterCharacteristic
- PUT Set Value MeterCharacteristic
- PUT Set CharacteristicEnumValueId MeterCharacteristic
- PUT Set Unit MeterCharacteristic
- PUT Set CharacteristicValueType MeterCharacteristic
- PUT Set CharacteristicValueTypeValue MeterCharacteristic
- PUT Set CharacteristicEnumValue MeterCharacteristic
- DELETE:
All Resources
This service uses the following resources:
- ApiMeterMeterCharacteristicsResource
- ApiMeterResource
- MeterResource
- MoneyResource
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET Meters (odata)
Returns a page of the list of all the entity records available.
The following elements are optional:
opts | (ODataQueryOptions) OData query option. |
Response:
When successful, the response body contains the list of records available. See MeterResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Meter by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body contains the entity record. See MeterResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
GET Meter by key
Returns the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
meterKey | (string) Meter. |
Response:
When successful, the response body contains the entity record. See MeterResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
POST Meters
Creates a new entity record.
The following elements are required:
meterResource | (ApiMeterResource) The request body should contain the entity record that should be created. See ApiMeterResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiMeterResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST MeterCharacteristic
Inserts a new 'MeterCharacteristic' in the 'Meter'.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (ApiMeterMeterCharacteristicsResource) The ApiMeterMeterCharacteristicsResource instance. See ApiMeterMeterCharacteristicsResource. |
The following elements are optional:
customAttributes | (JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AssetType Meter
Updates the value of attribute 'AssetType' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (enum ReportAssetType) The request body should contain the new value for the attribute. See ReportAssetType. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set AverageCalculationMethod Meter
Updates the value of attribute 'AverageCalculationMethod' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (enum AverageCalculationMethod) The request body should contain the new value for the attribute. See AverageCalculationMethod. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Brand Meter
Updates the value of attribute 'Brand' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set BrandModel Meter
Updates the value of attribute 'BrandModel' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Characteristic MeterCharacteristic
Updates the value of attribute 'Characteristic' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CharacteristicEnumValue MeterCharacteristic
Updates the value of attribute 'CharacteristicEnumValue' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CharacteristicEnumValueId MeterCharacteristic
Updates the value of attribute 'CharacteristicEnumValueId' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (Guid) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CharacteristicValueType MeterCharacteristic
Updates the value of attribute 'CharacteristicValueType' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set CharacteristicValueTypeValue MeterCharacteristic
Updates the value of attribute 'CharacteristicValueTypeValue' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Company Meter
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Currency Meter
Updates the value of attribute 'Currency' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description Meter
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Equipment Meter
Updates the value of attribute 'Equipment' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Family Meter
Updates the value of attribute 'Family' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set FromApi Meter
Updates the value of attribute 'FromApi' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set IsActive Meter
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (bool) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
PUT Set Location Meter
Updates the value of attribute 'Location' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LocationFunction Meter
Updates the value of attribute 'LocationFunction' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set LocationParentLocationHistoryId Meter
Updates the value of attribute 'LocationParentLocationHistoryId' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (Guid) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MaxValue Meter
Updates the value of attribute 'MaxValue' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MeterKey Meter
Updates the value of attribute 'MeterKey' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set MeterType Meter
Updates the value of attribute 'MeterType' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (enum MeterType) The request body should contain the new value for the attribute. See MeterType. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set ParentMeter Meter
Updates the value of attribute 'ParentMeter' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Remarks Meter
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Serial Meter
Updates the value of attribute 'Serial' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set SlidingWindowSize Meter
Updates the value of attribute 'SlidingWindowSize' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (int) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set StartValue Meter
Updates the value of attribute 'StartValue' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Tool Meter
Updates the value of attribute 'Tool' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Unit Meter
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Unit MeterCharacteristic
Updates the value of attribute 'Unit' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set UnitCost Meter
Updates the value of attribute 'UnitCost' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
value | (decimal) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Value MeterCharacteristic
Updates the value of attribute 'Value' in the specified entity record.
The following elements are required:
meterKey | (string) Meter. |
lineId | (string) The detail identifier. |
companyKey | (string) The company key. |
value | (string) The request body should contain the new value for the attribute. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Custom Attribute Meter
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
companyKey | (string) The company key. |
meterKey | (string) Meter |
customAttributeName | (string) The custom attribute name. |
value | (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource. |
Response:
When successful, the response body is empty. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE MeterCharacteristic by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
meterKey | (string) Meter. |
companyKey | (string) The company key. |
lineId | (string) The line identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | NoContent. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Meter by identifier
Deletes the entity record that matches the specified identifier.
The following elements are required:
id | (string) The record identifier. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
DELETE Meter by key
Deletes the entity record that matches the specified key.
The following elements are required:
companyKey | (string) The company key. |
meterKey | (string) Meter. |
Response:
When successful, the response body is empty. |
Response status codes:
204 | Deleted. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
404 | NotFound. The specified record does not exist. |
Resource URL:
Resources
ApiMeterMeterCharacteristicsResource
The following elements are required:
characteristic | (string) Characteristic. |
The following elements are optional:
value | (string) Value. |
characteristicEnumValueId | (Guid) Characteristic Enum Value Id. |
unit | (string) Unit. |
characteristicValueType | (string) Value Type. |
characteristicValueTypeValue | (int) Characteristic Value Type Value. |
characteristicEnumValue | (int) Enum Value. |
ApiMeterResource
The following elements are required:
meterKey | (string) Meter. |
description | (string) Description. |
meterType | (enum MeterType) Meter Type.
See MeterType. |
unit | (string) Unit. |
unitCost | (MoneyResource) Unit Cost.
See MoneyResource . |
currency | (string) Currency. |
company | (string) Company. |
fromApi | (bool) From Api. |
The following elements are optional:
locationFunction | (string) Location Function. |
family | (string) Family. |
brand | (string) Brand. |
brandModel | (string) Model. |
assetType | (enum ReportAssetType) Asset Type.
See ReportAssetType. |
location | (string) Location. |
equipment | (string) Equipment. |
tool | (string) Tool. |
parentMeter | (string) Parent Meter. |
averageCalculationMethod | (enum AverageCalculationMethod) Avg. Calculation Method.
See AverageCalculationMethod. |
slidingWindowSize | (int) Window Size of Moving Average. |
startValue | (decimal) Start Value. |
maxValue | (int) Max. Value. |
remarks | (string) Remarks. |
serial | (string) Series. |
locationParentLocationHistoryId | (Guid) Parent Location Change Id. |
meterCharacteristics | (List of ApiMeterMeterCharacteristicsResource) Meter Characteristics.
See ApiMeterMeterCharacteristicsResource. |
MeterResource
The following elements are required:
meterKey | (string) Meter. |
description | (string) Description. |
meterType | (enum MeterType) Meter Type.
See MeterType. |
unit | (string) Unit.
(fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units service. |
unitCost | (MoneyResource) Unit Cost.
See MoneyResource . |
currency | (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
company | (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
fromApi | (bool) From Api. |
The following elements are optional:
locationFunction | (string) Location Function.
(fk) Allowed value: the natural key of a record of type LocationFunction. These records are accessibly through the LocationFunctions service. |
family | (string) Family.
(fk) Allowed value: the natural key of a record of type Family. These records are accessibly through the Families service. |
brand | (string) Brand.
(fk) Allowed value: the natural key of a record of type Brand. These records are accessibly through the Brands service. |
brandModel | (string) Model.
(fk) Allowed value: the natural key of a record of type BrandModel. These records are accessibly through the BrandModels service. |
assetType | (enum ReportAssetType) Asset Type.
See ReportAssetType. |
location | (string) Location.
(fk) Allowed value: the natural key of a record of type Location. These records are accessibly through the Locations service. |
equipment | (string) Equipment.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service. |
tool | (string) Tool.
(fk) Allowed value: the natural key of a record of type EquipmentItem. These records are accessibly through the EquipmentItems service. |
parentMeter | (string) Parent Meter.
(fk) Allowed value: the natural key of a record of type Meter. These records are accessibly through the Meters service. |
averageCalculationMethod | (enum AverageCalculationMethod) Avg. Calculation Method.
See AverageCalculationMethod. |
slidingWindowSize | (int) Window Size of Moving Average. |
startValue | (decimal) Start Value. |
maxValue | (int) Max. Value. |
remarks | (string) Remarks. |
serial | (string) Series. |
locationParentLocationHistoryId | (Guid) Parent Location Change Id. |
meterCharacteristics | (List of MeterCharacteristicResource) Meter Characteristics.
See MeterCharacteristicResource. |
MoneyResource
The following elements are required:
amount | (decimal) The amount. |
The following elements are optional:
baseAmount | (decimal) The base amount. |
reportingAmount | (decimal) The reporting amount. |
fractionDigits | (int) The fraction digits. |
symbol | (string) The symbol. |
Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.
ExtensibilityCustomAttributeValueResource
The following elements are required:
value | (object) The custom attribute value. |