Assets | Monitoring

Service to manage entities of type 'Monitoring'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Monitorings (odata)
  • GET Monitoring by identifier
  • GET Monitoring by key
• POST:
  • POST Monitorings
  • POST MonitoringCharacteristic
  • POST Get Notification Template Parameters
• PUT:
  • PUT Set Custom Attribute Monitoring
  • PUT Set IsActive Monitoring
  • PUT Set MonitoringKey Monitoring
  • PUT Set Description Monitoring
  • PUT Set Unit Monitoring
  • PUT Set LocationFunction Monitoring
  • PUT Set Family Monitoring
  • PUT Set Brand Monitoring
  • PUT Set BrandModel Monitoring
  • PUT Set AssetType Monitoring
  • PUT Set Location Monitoring
  • PUT Set Equipment Monitoring
  • PUT Set Tool Monitoring
  • PUT Set UpperActionLimit Monitoring
  • PUT Set UpperWarningLimit Monitoring
  • PUT Set UpperActionTriggerEvents Monitoring
  • PUT Set UpperActionCreateRequest Monitoring
  • PUT Set UpperRequestType Monitoring
  • PUT Set UpperRequestReason Monitoring
  • PUT Set LowerActionLimit Monitoring
  • PUT Set LowerWarningLimit Monitoring
  • PUT Set LowerActionTriggerEvents Monitoring
  • PUT Set LowerActionCreateRequest Monitoring
  • PUT Set LowerRequestType Monitoring
  • PUT Set LowerRequestReason Monitoring
  • PUT Set AverageWindow Monitoring
  • PUT Set Company Monitoring
  • PUT Set Remarks Monitoring
  • PUT Set UpperActionCreateWorkOrder Monitoring
  • PUT Set LowerActionCreateWorkOrder Monitoring
  • PUT Set UpperWorkOrderType Monitoring
  • PUT Set LowerWorkOrderType Monitoring
  • PUT Set FromApi Monitoring
  • PUT Set ConnectToIot Monitoring
  • PUT Set Characteristic MonitoringCharacteristic
  • PUT Set Value MonitoringCharacteristic
  • PUT Set CharacteristicEnumValueId MonitoringCharacteristic
  • PUT Set Unit MonitoringCharacteristic
  • PUT Set CharacteristicValueType MonitoringCharacteristic
  • PUT Set CharacteristicValueTypeValue MonitoringCharacteristic
  • PUT Set CharacteristicEnumValue MonitoringCharacteristic
• DELETE:
  • DELETE MonitoringCharacteristic by identifier
  • DELETE Monitoring by identifier
  • DELETE Monitoring by key

All Resources

This service uses the following resources:

• ApiMonitoringMonitoringCharacteristicsResource
• ApiMonitoringResource
• MonitoringResource
• MonitoringTemplateParameter
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• ReportAssetType

GET Operations

GET Monitorings (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 MonitoringResource.

Response status codes:

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

Resource URL:

GET Monitoring 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 MonitoringResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
monitoringKey	(string) Monitoring.

Response:

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

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 Monitorings

Creates a new entity record.

The following elements are required:

monitoringResource

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

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

Response status codes:

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

Resource URL:

POST MonitoringCharacteristic

Inserts a new 'MonitoringCharacteristic' in the 'Monitoring'.

The following elements are required:

monitoringKey	(string) Monitoring.
companyKey	(string) The company key.
value	(ApiMonitoringMonitoringCharacteristicsResource) The ApiMonitoringMonitoringCharacteristicsResource instance. See ApiMonitoringMonitoringCharacteristicsResource.

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:

POST Get Notification Template Parameters

Custom operation 'GetNotificationTemplateParameters'.

The following elements are required:

id	(Guid) Id.
cultureKey	(string) CultureKey.

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 a list of resources of type 'MonitoringTemplateParameter'. See MonitoringTemplateParameter.

Resource URL:

PUT Operations

PUT Set AssetType Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 AverageWindow Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Brand Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 ConnectToIot Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Description Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerActionCreateRequest Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerActionCreateWorkOrder Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerActionLimit Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerActionTriggerEvents Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerRequestReason Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerRequestType Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerWarningLimit Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 LowerWorkOrderType Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringKey Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperActionCreateRequest Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperActionCreateWorkOrder Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperActionLimit Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperActionTriggerEvents Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperRequestReason Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperRequestType Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperWarningLimit Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 UpperWorkOrderType Monitoring

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 MonitoringCharacteristic

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

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring

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

The following elements are required:

companyKey	(string) The company key.
monitoringKey	(string) Monitoring
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 MonitoringCharacteristic by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

monitoringKey	(string) Monitoring.
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 Monitoring 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 Monitoring by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
monitoringKey	(string) Monitoring.

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

ApiMonitoringMonitoringCharacteristicsResource

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.

ApiMonitoringResource

The following elements are required:

monitoringKey	(string) Monitoring.
description	(string) Description.
unit	(string) Unit.
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.
upperActionLimit	(decimal) Action.
upperWarningLimit	(decimal) Warning.
upperActionTriggerEvents	(int) Trigger Events.
upperActionCreateRequest	(bool) Create Request.
upperRequestType	(string) Request Type.
upperRequestReason	(string) Request Reason.
lowerActionLimit	(decimal) Action.
lowerWarningLimit	(decimal) Warning.
lowerActionTriggerEvents	(int) Trigger Events.
lowerActionCreateRequest	(bool) Create Request.
lowerRequestType	(string) Request Type.
lowerRequestReason	(string) Request Reason.
averageWindow	(int) Window.
remarks	(string) Remarks.
upperActionCreateWorkOrder	(bool) Create Work Order.
lowerActionCreateWorkOrder	(bool) Create Work Order.
upperWorkOrderType	(string) Work Order Type.
lowerWorkOrderType	(string) Work Order Type.
monitoringCharacteristics	(List of ApiMonitoringMonitoringCharacteristicsResource) Monitoring Characteristics. See ApiMonitoringMonitoringCharacteristicsResource.
connectToIot	(bool) Connect To Iot.

MonitoringResource

The following elements are required:

monitoringKey	(string) Monitoring.
description	(string) Description.
unit	(string) Unit. (fk) Allowed value: the natural key of a record of type Unit. These records are accessibly through the Units 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.
upperActionLimit	(decimal) Action.
upperWarningLimit	(decimal) Warning.
upperActionTriggerEvents	(int) Trigger Events.
upperActionCreateRequest	(bool) Create Request.
upperRequestType	(string) Request Type. (fk) Allowed value: the natural key of a record of type RequestType. These records are accessibly through the RequestTypes service.
upperRequestReason	(string) Request Reason. (fk) Allowed value: the natural key of a record of type RequestReason. These records are accessibly through the RequestReasons service.
lowerActionLimit	(decimal) Action.
lowerWarningLimit	(decimal) Warning.
lowerActionTriggerEvents	(int) Trigger Events.
lowerActionCreateRequest	(bool) Create Request.
lowerRequestType	(string) Request Type. (fk) Allowed value: the natural key of a record of type RequestType. These records are accessibly through the RequestTypes service.
lowerRequestReason	(string) Request Reason. (fk) Allowed value: the natural key of a record of type RequestReason. These records are accessibly through the RequestReasons service.
averageWindow	(int) Window.
remarks	(string) Remarks.
upperActionCreateWorkOrder	(bool) Create Work Order.
lowerActionCreateWorkOrder	(bool) Create Work Order.
upperWorkOrderType	(string) Work Order Type. (fk) Allowed value: the natural key of a record of type WorkOrderType. These records are accessibly through the WorkOrderTypes service.
lowerWorkOrderType	(string) Work Order Type. (fk) Allowed value: the natural key of a record of type WorkOrderType. These records are accessibly through the WorkOrderTypes service.
monitoringCharacteristics	(List of MonitoringCharacteristicResource) Monitoring Characteristics. See MonitoringCharacteristicResource.
connectToIot	(bool) Connect To Iot.
log	(string) Log.

MonitoringTemplateParameter

The following elements are optional:

name	(string) Name.
value	(string) Value.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

ReportAssetType

1	Location
2	Equipment
3	Tool