Valuekeep Developers - Web API Reference

Work | Failure

Service to manage entities of type 'Failure'.

Overview


URL api/{tenantKey}/{orgKey}/maintenance/failures
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET Failures (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 FailureResource.

Response status codes:

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

Resource URL:

GET /maintenance/failures/odata

GET Failure 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 FailureResource.

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 /maintenance/failures/{id}

GET Failure by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
failureKey (string) Failure.

Response:

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

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 /maintenance/failures/{companyKey}/{failureKey}

GET Asset Has Failures

Custom operation 'AssetHasFailures'.

The following elements are required:

assetId (Guid) AssetId.

Response:

When successful, the response body contains an item of type 'boolean'.

Response status codes:

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

Resource URL:

GET /maintenance/failures/assetHasFailures/{assetId}

POST Operations

POST Failures

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /maintenance/failures

POST Failure Typification

Inserts a new 'Failure Typification' in the 'Failure'.

The following elements are required:

failureKey (string) Failure.
companyKey (string) The company key.
value (ApiFailureFailureTypificationsResource) The ApiFailureFailureTypificationsResource instance.
See ApiFailureFailureTypificationsResource.

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 /maintenance/failures/{companyKey}/{failureKey}/failureTypifications

POST Update Failure Info

Custom operation 'UpdateFailureInfo'.

The following elements are required:

companyKey (string) CompanyKey.
failureKey (string) FailureKey.
failureInfo (FailureInfoResource) FailureInfo.

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 resource of type 'FailureInfoResource'. See FailureInfoResource.

Resource URL:

POST /maintenance/failures/updateFailureInfo/{companyKey}/{failureKey}

PUT Operations

PUT Set AssetType Failure

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

The following elements are required:

failureKey (string) Failure.
companyKey (string) The company key.
value (enum EquipmentItemType) The request body should contain the new value for the attribute.
See EquipmentItemType.

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 /maintenance/failures/{companyKey}/{failureKey}/assetType

PUT Set CausedEnvironmentalDamage Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/causedEnvironmentalDamage

PUT Set CausedPersonalInjury Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/causedPersonalInjury

PUT Set Company Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/company

PUT Set Description Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/description

PUT Set Equipment Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/equipment

PUT Set FailureAction FailureTypification

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureTypifications/{lineId}/failureAction

PUT Set FailureCause FailureTypification

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureTypifications/{lineId}/failureCause

PUT Set FailureDate Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureDate

PUT Set FailureKey Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureKey

PUT Set FailureSymptom FailureTypification

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureTypifications/{lineId}/failureSymptom

PUT Set IncreasedRiskPersonalInjury Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/increasedRiskPersonalInjury

PUT Set IsActive Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/isActive

PUT Set MaintenanceRoute Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/maintenanceRoute

PUT Set Remarks Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/remarks

PUT Set Tool Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/tool

PUT Set WorkOrder Failure

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

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/workOrder

PUT Set Custom Attribute Failure

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

The following elements are required:

companyKey (string) The company key.
failureKey (string) Failure
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 /maintenance/failures/{companyKey}/{failureKey}/{customAttributeName}

PUT Set Custom Attribute FailureTypification

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

The following elements are required:

companyKey (string) The company key.
failureKey (string) Failure
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:

PUT /maintenance/failures/{companyKey}/{failureKey}/failureTypifications/{lineId}/{customAttributeName}

DELETE Operations

DELETE Failure Typification by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

failureKey (string) Failure.
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 /maintenance/failures/{companyKey}/{failureKey}/failureTypifications/{lineId}

DELETE Failure 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 /maintenance/failures/{id}

DELETE Failure by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
failureKey (string) Failure.

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 /maintenance/failures/{companyKey}/{failureKey}

Resources


ApiFailureFailureTypificationsResource

The following elements are required:

failureSymptom (string) Failure Symptom.
failureCause (string) Failure Cause.
failureAction (string) Failure Action.


ApiFailureResource

The following elements are required:

failureKey (string) Failure.
description (string) Description.
failureDate (DateTimeOffset) Date.
workOrder (string) Work Order.
assetType (enum EquipmentItemType) Type.
See EquipmentItemType.
company (string) Company.

The following elements are optional:

equipment (string) Equipment.
tool (string) Tool.
causedEnvironmentalDamage (bool) Caused Environmental Damage?.
causedPersonalInjury (bool) Caused Personal Injury?.
increasedRiskPersonalInjury (bool) Increased Risk of Personal Injury?.
failureTypifications (List of ApiFailureFailureTypificationsResource) Failure Typifications.
See ApiFailureFailureTypificationsResource.
remarks (string) Remarks.
maintenanceRoute (string) Route.


FailureInfoResource

The following elements are required:

assetType (enum EquipmentItemType) Type.
See EquipmentItemType.
company (string) Company.
description (string) Description.
failureAction (string) Failure Action.
failureCause (string) Failure Cause.
failureDate (DateTimeOffset) Date.
failureKey (string) Failure.
failureSymptom (string) Failure Symptom.
workOrder (string) Work Order.

The following elements are optional:

causedEnvironmentalDamage (bool) Caused Environmental Damage?.
causedPersonalInjury (bool) Caused Personal Injury?.
equipment (string) Equipment.
failureTypifications (string) Failure Typifications.
increasedRiskPersonalInjury (bool) Increased Risk of Personal Injury?.
remarks (string) Remarks.
tool (string) Tool.


FailureResource

The following elements are required:

failureKey (string) Failure.
description (string) Description.
failureDate (DateTimeOffset) Date.
workOrder (string) Work Order.
assetType (enum EquipmentItemType) Type.
See EquipmentItemType.
company (string) Company.

The following elements are optional:

equipment (string) Equipment.
tool (string) Tool.
causedEnvironmentalDamage (bool) Caused Environmental Damage?.
causedPersonalInjury (bool) Caused Personal Injury?.
increasedRiskPersonalInjury (bool) Increased Risk of Personal Injury?.
failureTypifications (List of FailureTypificationResource) Failure Typifications.
See FailureTypificationResource.
remarks (string) Remarks.
maintenanceRoute (string) Route.


FailureTypificationResource

The following elements are required:

failureSymptom (string) Failure Symptom.
failureCause (string) Failure Cause.
failureAction (string) Failure Action.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.

Enumerations


EquipmentItemType

2 Equipment
3 Tool