Assets | Monitoring Value
Service to manage entities of type 'MonitoringValue'.
Overview
| URL | api/{tenantKey}/{orgKey}/assetManagement/monitoringValues |
| Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
-
PUT:
- PUT Set Custom Attribute MonitoringValue
- PUT Set IsActive MonitoringValue
- PUT Set MonitoringValueKey MonitoringValue
- PUT Set Request MonitoringValue
- PUT Set Remarks MonitoringValue
- PUT Set Company MonitoringValue
- PUT Set MovingAverage MonitoringValue
- PUT Set AverageWindow MonitoringValue
- PUT Set MonitoringForAsset MonitoringValue
- PUT Set FromMonitoring MonitoringValue
- DELETE:
All Resources
This service uses the following resources:
- ApiMonitoringValueResource
- MonitoringValueResource
- MonitoringValueTemplateParameter
- ExtensibilityCustomAttributeValueResource
All Enumerations
This service uses the following enumerations:
GET MonitoringValues (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 MonitoringValueResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET MonitoringValue 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 MonitoringValueResource. |
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 MonitoringValue by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| monitoringValueKey | (string) Monitoring Value. |
Response:
| When successful, the response body contains the entity record. See MonitoringValueResource. |
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 MonitoringValues
Creates a new entity record.
The following elements are required:
| monitoringValueResource | (ApiMonitoringValueResource) The request body should contain the entity record that should be created. See ApiMonitoringValueResource. |
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 ApiMonitoringValueResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Check Triggered Limit
Custom operation 'CheckTriggeredLimit'.
The following elements are required:
| monitoringValueId | (Guid) MonitoringValueId. |
| monitoringId | (Guid) MonitoringId. |
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 an item of type 'number'. |
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 'MonitoringValueTemplateParameter'. See MonitoringValueTemplateParameter. |
Resource URL:
PUT Set AverageWindow MonitoringValue
Updates the value of attribute 'AverageWindow' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) Monitoring Value. |
| 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 MonitoringValue
Updates the value of attribute 'Company' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 FromMonitoring MonitoringValue
Updates the value of attribute 'FromMonitoring' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 IsActive MonitoringValue
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 MonitoringForAsset MonitoringValue
Updates the value of attribute 'MonitoringForAsset' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 MonitoringValueKey MonitoringValue
Updates the value of attribute 'MonitoringValueKey' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 MovingAverage MonitoringValue
Updates the value of attribute 'MovingAverage' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) Monitoring Value. |
| 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 Remarks MonitoringValue
Updates the value of attribute 'Remarks' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 Request MonitoringValue
Updates the value of attribute 'Request' in the specified entity record.
The following elements are required:
| monitoringValueKey | (string) 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 MonitoringValue
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| monitoringValueKey | (string) 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:
DELETE MonitoringValue 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 MonitoringValue by key
Deletes the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| monitoringValueKey | (string) 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
ApiMonitoringValueResource
The following elements are required:
| monitoringValueKey | (string) Monitoring Value. |
| monitoring | (string) Monitoring. |
| origin | (enum MonitoringValueOrigin) Origin.
See MonitoringValueOrigin. |
| value | (decimal) Value. |
| date | (DateTimeOffset) Date. |
| company | (string) Company. |
| monitoringForAsset | (bool) Monitoring For Asset. |
| fromMonitoring | (bool) From Monitoring. |
The following elements are optional:
| assetType | (enum ReportAssetType) Asset Type.
See ReportAssetType. |
| location | (string) Location. |
| equipment | (string) Equipment. |
| tool | (string) Tool. |
| workOrder | (string) Work Order. |
| request | (string) Request. |
| remarks | (string) Remarks. |
| movingAverage | (decimal) Moving Average. |
| averageWindow | (int) Average Window. |
MonitoringValueResource
The following elements are required:
| monitoringValueKey | (string) Monitoring Value. |
| monitoring | (string) Monitoring. |
| origin | (enum MonitoringValueOrigin) Origin.
See MonitoringValueOrigin. |
| value | (decimal) Value. |
| date | (DateTimeOffset) Date. |
| company | (string) Company. |
| monitoringForAsset | (bool) Monitoring For Asset. |
| fromMonitoring | (bool) From Monitoring. |
The following elements are optional:
| assetType | (enum ReportAssetType) Asset Type.
See ReportAssetType. |
| location | (string) Location. |
| equipment | (string) Equipment. |
| tool | (string) Tool. |
| workOrder | (string) Work Order. |
| request | (string) Request. |
| remarks | (string) Remarks. |
| movingAverage | (decimal) Moving Average. |
| averageWindow | (int) Average Window. |
MonitoringValueTemplateParameter
The following elements are optional:
| name | (string) Name. |
| value | (string) Value. |
ExtensibilityCustomAttributeValueResource
The following elements are required:
| value | (object) The custom attribute value. |