Assets | Meter Readings for WO

Service to manage entities of type 'WOMeterReading'.

Overview

URL	api/{tenantKey}/{orgKey}/assetManagement/wOMeterReadings
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET WOMeterReadings (odata)
  • GET WOMeterReading by identifier
  • GET WOMeterReading by key
• POST:
  • POST WOMeterReadings
  • POST Meter Readings Items
• PUT:
  • PUT Set Custom Attribute WOMeterReading
  • PUT Set Custom Attribute WOMeterReadingItem
  • PUT Set IsActive WOMeterReading
  • PUT Set WOMeterReadingKey WOMeterReading
  • PUT Set WorkOrder WOMeterReading
  • PUT Set LoadChildMeters WOMeterReading
  • PUT Set Company WOMeterReading
  • PUT Set AllowReportWork WOMeterReading
  • PUT Set Meter WOMeterReadingItem
  • PUT Set IncrementValue WOMeterReadingItem
  • PUT Set MeterReading WOMeterReadingItem
  • PUT Set Date WOMeterReadingItem
  • PUT Set Location WOMeterReadingItem
  • PUT Set Equipment WOMeterReadingItem
  • PUT Set Tool WOMeterReadingItem
  • PUT Set MeterType WOMeterReadingItem
  • PUT Set Asset WOMeterReadingItem
  • PUT Set AssetType WOMeterReadingItem
  • PUT Set CanUpdate WOMeterReadingItem
• DELETE:
  • DELETE Meter Readings Items by identifier
  • DELETE WOMeterReading by identifier
  • DELETE WOMeterReading by key

All Resources

This service uses the following resources:

• ApiWOMeterReadingMeterReadingsItemsResource
• ApiWOMeterReadingResource
• WOMeterReadingResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET WOMeterReadings (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 WOMeterReadingResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET WOMeterReading 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 WOMeterReadingResource.

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 WOMeterReading by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
wOMeterReadingKey	(string) WO Meter Reading.

Response:

When successful, the response body contains the entity record. See WOMeterReadingResource.

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 Operations

POST WOMeterReadings

Creates a new entity record.

The following elements are required:

wOMeterReadingResource

(ApiWOMeterReadingResource) The request body should contain the entity record that should be created. See ApiWOMeterReadingResource.

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 ApiWOMeterReadingResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Meter Readings Items

Inserts a new 'Meter Readings Items' in the 'Meter Readings'.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
companyKey	(string) The company key.
value	(ApiWOMeterReadingMeterReadingsItemsResource) The ApiWOMeterReadingMeterReadingsItemsResource instance. See ApiWOMeterReadingMeterReadingsItemsResource.

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 Operations

PUT Set AllowReportWork WOMeterReading

Updates the value of attribute 'AllowReportWork' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 Asset WOMeterReadingItem

Updates the value of attribute 'Asset' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 AssetType WOMeterReadingItem

Updates the value of attribute 'AssetType' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 CanUpdate WOMeterReadingItem

Updates the value of attribute 'CanUpdate' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
lineId	(string) The detail identifier.
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 Company WOMeterReading

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 Date WOMeterReadingItem

Updates the value of attribute 'Date' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(DateTimeOffset) 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 WOMeterReadingItem

Updates the value of attribute 'Equipment' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 IncrementValue WOMeterReadingItem

Updates the value of attribute 'IncrementValue' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
lineId	(string) The detail identifier.
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 IsActive WOMeterReading

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 LoadChildMeters WOMeterReading

Updates the value of attribute 'LoadChildMeters' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 Location WOMeterReadingItem

Updates the value of attribute 'Location' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 Meter WOMeterReadingItem

Updates the value of attribute 'Meter' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 MeterReading WOMeterReadingItem

Updates the value of attribute 'MeterReading' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
lineId	(string) The detail identifier.
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 MeterType WOMeterReadingItem

Updates the value of attribute 'MeterType' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 Tool WOMeterReadingItem

Updates the value of attribute 'Tool' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 WOMeterReadingKey WOMeterReading

Updates the value of attribute 'WOMeterReadingKey' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 WorkOrder WOMeterReading

Updates the value of attribute 'WorkOrder' in the specified entity record.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 WOMeterReading

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
wOMeterReadingKey	(string) WO Meter Reading
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:

PUT Set Custom Attribute WOMeterReadingItem

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
wOMeterReadingKey	(string) WO Meter Reading
lineId	(string) The detail identifier.
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 Operations

DELETE Meter Readings Items by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
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 WOMeterReading 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 WOMeterReading by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
wOMeterReadingKey	(string) WO Meter Reading.

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

ApiWOMeterReadingMeterReadingsItemsResource

The following elements are required:

meter	(string) Meter.
date	(DateTimeOffset) Date.
meterType	(int) Meter Type.
canUpdate	(bool) Can Update.

The following elements are optional:

incrementValue	(decimal) Increment.
meterReading	(decimal) Reading.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
asset	(string) Asset.
assetType	(string) Asset Type.

ApiWOMeterReadingResource

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
workOrder	(string) Work Order.
loadChildMeters	(bool) Load Child Asset Meters.
company	(string) Company.
allowReportWork	(bool) Allow Report Work.

The following elements are optional:

meterReadingsItems

(List of ApiWOMeterReadingMeterReadingsItemsResource) Meter Readings Items. See ApiWOMeterReadingMeterReadingsItemsResource.

WOMeterReadingResource

The following elements are required:

wOMeterReadingKey	(string) WO Meter Reading.
workOrder	(string) Work Order. (fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
loadChildMeters	(bool) Load Child Asset Meters.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
allowReportWork	(bool) Allow Report Work.

The following elements are optional:

meterReadingsItems

(List of WOMeterReadingItemResource) Meter Readings Items. See WOMeterReadingItemResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.