Assets | Monitoring Value for WO

Service to manage entities of type 'WOMonitoringValue'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET WOMonitoringValues (odata)
  • GET WOMonitoringValue by identifier
  • GET WOMonitoringValue by key
• POST:
  • POST WOMonitoringValues
  • POST WO Monitoring Values Item
• PUT:
  • PUT Set Custom Attribute WOMonitoringValue
  • PUT Set Custom Attribute WOMonitoringValuesItem
  • PUT Set IsActive WOMonitoringValue
  • PUT Set WOMonitoringValueKey WOMonitoringValue
  • PUT Set WorkOrder WOMonitoringValue
  • PUT Set LoadChildAssetMonitorings WOMonitoringValue
  • PUT Set Company WOMonitoringValue
  • PUT Set AllowReportWork WOMonitoringValue
  • PUT Set Monitoring WOMonitoringValuesItem
  • PUT Set Date WOMonitoringValuesItem
  • PUT Set Equipment WOMonitoringValuesItem
  • PUT Set Tool WOMonitoringValuesItem
  • PUT Set Location WOMonitoringValuesItem
  • PUT Set Value WOMonitoringValuesItem
  • PUT Set Asset WOMonitoringValuesItem
  • PUT Set AssetType WOMonitoringValuesItem
  • PUT Set CanUpdate WOMonitoringValuesItem
• DELETE:
  • DELETE WO Monitoring Values Item by identifier
  • DELETE WOMonitoringValue by identifier
  • DELETE WOMonitoringValue by key

All Resources

This service uses the following resources:

• ApiWOMonitoringValueMonitoringValuesItemsResource
• ApiWOMonitoringValueResource
• WOMonitoringValueResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET WOMonitoringValues (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 WOMonitoringValueResource.

Response status codes:

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

Resource URL:

GET WOMonitoringValue 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 WOMonitoringValueResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
wOMonitoringValueKey	(string) WO Monitoring Value.

Response:

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

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 WOMonitoringValues

Creates a new entity record.

The following elements are required:

wOMonitoringValueResource

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

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

Response status codes:

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

Resource URL:

POST WO Monitoring Values Item

Inserts a new 'WO Monitoring Values Item' in the 'WO Monitoring Value'.

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
companyKey	(string) The company key.
value	(ApiWOMonitoringValueMonitoringValuesItemsResource) The ApiWOMonitoringValueMonitoringValuesItemsResource instance. See ApiWOMonitoringValueMonitoringValuesItemsResource.

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 WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 IsActive WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 LoadChildAssetMonitorings WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 Monitoring WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 Tool WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 Value WOMonitoringValuesItem

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValueKey WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValue

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

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValue

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

The following elements are required:

companyKey	(string) The company key.
wOMonitoringValueKey	(string) WO Monitoring Value
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 WOMonitoringValuesItem

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

The following elements are required:

companyKey	(string) The company key.
wOMonitoringValueKey	(string) WO Monitoring Value
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 WO Monitoring Values Item by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
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 WOMonitoringValue 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 WOMonitoringValue by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
wOMonitoringValueKey	(string) WO Monitoring Value.

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

ApiWOMonitoringValueMonitoringValuesItemsResource

The following elements are required:

monitoring	(string) Monitoring.
date	(DateTimeOffset) Date.
tool	(string) Tool.
canUpdate	(bool) Can Update.

The following elements are optional:

equipment	(string) Equipment.
location	(string) Location.
value	(decimal) Value.
asset	(string) Asset.
assetType	(string) Asset Type.

ApiWOMonitoringValueResource

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
workOrder	(string) Work Order.
loadChildAssetMonitorings	(bool) Load Child Asset Monitorings.
company	(string) Company.
allowReportWork	(bool) Allow Report Work.

The following elements are optional:

monitoringValuesItems

(List of ApiWOMonitoringValueMonitoringValuesItemsResource) Monitoring Values Items. See ApiWOMonitoringValueMonitoringValuesItemsResource.

WOMonitoringValueResource

The following elements are required:

wOMonitoringValueKey	(string) WO Monitoring Value.
workOrder	(string) Work Order. (fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
loadChildAssetMonitorings	(bool) Load Child Asset Monitorings.
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:

monitoringValuesItems

(List of WOMonitoringValuesItemResource) Monitoring Values Items. See WOMonitoringValuesItemResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.