Valuekeep Developers - Web API Reference

Assets | Assets Indicator

Service to manage entities of type 'AssetsIndicator'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET AssetsIndicators (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 AssetsIndicatorResource.

Response status codes:

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

Resource URL:

GET /assetManagement/assetsIndicators/odata

GET AssetsIndicator 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 AssetsIndicatorResource.

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 /assetManagement/assetsIndicators/{id}

GET AssetsIndicator by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
assetsIndicatorKey (string) Assets Indicator.

Response:

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

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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}

POST Operations

POST AssetsIndicators

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /assetManagement/assetsIndicators

PUT Operations

PUT Set AssetsIndicatorKey AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/assetsIndicatorKey

PUT Set Company AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/company

PUT Set Equipment AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/equipment

PUT Set Failures AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/failures

PUT Set GlobalMTTR AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/globalMTTR

PUT Set IsActive AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/isActive

PUT Set Month AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/month

PUT Set MonthMTTR AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/monthMTTR

PUT Set RepairTime AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/repairTime

PUT Set Tool AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/tool

PUT Set Year AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/year

PUT Set YearMTTR AssetsIndicator

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

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/yearMTTR

PUT Set Custom Attribute AssetsIndicator

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

The following elements are required:

companyKey (string) The company key.
assetsIndicatorKey (string) Assets Indicator
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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}/{customAttributeName}

DELETE Operations

DELETE AssetsIndicator 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 /assetManagement/assetsIndicators/{id}

DELETE AssetsIndicator by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
assetsIndicatorKey (string) Assets Indicator.

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 /assetManagement/assetsIndicators/{companyKey}/{assetsIndicatorKey}

Resources


ApiAssetsIndicatorResource

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
company (string) Company.

The following elements are optional:

equipment (string) Equipment.
tool (string) Tool.
year (int) Year.
month (int) Month.
monthMTTR (decimal) Month MTTR.
yearMTTR (decimal) Year MTTR.
globalMTTR (decimal) Global MTTR.
failures (int) Failures.
repairTime (decimal) Repair Time.


AssetsIndicatorResource

The following elements are required:

assetsIndicatorKey (string) Assets Indicator.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

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.
year (int) Year.
month (int) Month.
monthMTTR (decimal) Month MTTR.
yearMTTR (decimal) Year MTTR.
globalMTTR (decimal) Global MTTR.
failures (int) Failures.
repairTime (decimal) Repair Time.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.