Work | Preventive Maintenance Event

Service to manage entities of type 'PreventiveMaintenanceEvent'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET PreventiveMaintenanceEvents (odata)
  • GET PreventiveMaintenanceEvent by identifier
  • GET PreventiveMaintenanceEvent by key
• POST:
  • POST PreventiveMaintenanceEvents
  • POST Projection Work Order
• PUT:
  • PUT Set Custom Attribute PreventiveMaintenanceEvent
  • PUT Set Custom Attribute ProjectionWorkOrder
  • PUT Set IsActive PreventiveMaintenanceEvent
  • PUT Set PreventiveMaintenance PreventiveMaintenanceEvent
  • PUT Set Occurrence PreventiveMaintenanceEvent
  • PUT Set MaintenancePlan PreventiveMaintenanceEvent
  • PUT Set PredictedDate PreventiveMaintenanceEvent
  • PUT Set RecurrenceFrequency PreventiveMaintenanceEvent
  • PUT Set WorkOrder PreventiveMaintenanceEvent
  • PUT Set IsDelayed PreventiveMaintenanceEvent
  • PUT Set FixedDate PreventiveMaintenanceEvent
  • PUT Set Company PreventiveMaintenanceEvent
  • PUT Set AllowCreateWorkOrder PreventiveMaintenanceEvent
  • PUT Set NotificationSent PreventiveMaintenanceEvent
  • PUT Set MeterCumulativeReading PreventiveMaintenanceEvent
  • PUT Set WorkOrder ProjectionWorkOrder
• DELETE:
  • DELETE Projection Work Order by identifier
  • DELETE PreventiveMaintenanceEvent by identifier
  • DELETE PreventiveMaintenanceEvent by key

All Resources

This service uses the following resources:

• ApiPreventiveMaintenanceEventProjectionWorkOrdersResource
• ApiPreventiveMaintenanceEventResource
• PreventiveMaintenanceEventResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• RecurrenceFrequency

GET Operations

GET PreventiveMaintenanceEvents (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 PreventiveMaintenanceEventResource.

Response status codes:

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

Resource URL:

GET PreventiveMaintenanceEvent 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 PreventiveMaintenanceEventResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.

Response:

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

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 PreventiveMaintenanceEvents

Creates a new entity record.

The following elements are required:

preventiveMaintenanceEventResource

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

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

Response status codes:

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

Resource URL:

POST Projection Work Order

Inserts a new 'Projection Work Order' in the 'Preventive Maintenance Event'.

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
companyKey	(string) The company key.
value	(ApiPreventiveMaintenanceEventProjectionWorkOrdersResource) The ApiPreventiveMaintenanceEventProjectionWorkOrdersResource instance. See ApiPreventiveMaintenanceEventProjectionWorkOrdersResource.

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 AllowCreateWorkOrder PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 FixedDate PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 IsActive PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 IsDelayed PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 MaintenancePlan PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 MeterCumulativeReading PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 NotificationSent PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 Occurrence PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 PredictedDate PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 PreventiveMaintenance PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 RecurrenceFrequency PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
companyKey	(string) The company key.
value	(enum RecurrenceFrequency) The request body should contain the new value for the attribute. See RecurrenceFrequency.

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 PreventiveMaintenanceEvent

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 ProjectionWorkOrder

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

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 PreventiveMaintenanceEvent

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

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenance	(string) Preventive Maintenance
occurrence	(int) Event
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 ProjectionWorkOrder

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

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenance	(string) Preventive Maintenance
occurrence	(int) Event
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 Projection Work Order by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
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 PreventiveMaintenanceEvent 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 PreventiveMaintenanceEvent by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.

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

ApiPreventiveMaintenanceEventProjectionWorkOrdersResource

The following elements are required:

workOrder

(string) Work Order.

ApiPreventiveMaintenanceEventResource

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance.
occurrence	(int) Event.
maintenancePlan	(string) Maintenance Plan.
predictedDate	(DateTimeOffset) Predicted Date.
recurrenceFrequency	(enum RecurrenceFrequency) Recurrence Frequency. See RecurrenceFrequency.
company	(string) Company.
allowCreateWorkOrder	(bool) Allow Create Work Order.
notificationSent	(bool) Notification Sent.

The following elements are optional:

workOrder	(string) Work Order.
isDelayed	(bool) Is Delayed.
fixedDate	(DateTimeOffset) Fixed Date.
projectionWorkOrders	(List of ApiPreventiveMaintenanceEventProjectionWorkOrdersResource) Preventive Maint. Events. See ApiPreventiveMaintenanceEventProjectionWorkOrdersResource.
meterCumulativeReading	(decimal) Meter Cumulative Reading.

PreventiveMaintenanceEventResource

The following elements are required:

preventiveMaintenance	(string) Preventive Maintenance. (fk) Allowed value: the natural key of a record of type PreventiveMaintenance. These records are accessibly through the PreventiveMaintenances service.
occurrence	(int) Event.
maintenancePlan	(string) Maintenance Plan. (fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
predictedDate	(DateTimeOffset) Predicted Date.
recurrenceFrequency	(enum RecurrenceFrequency) Recurrence Frequency. See RecurrenceFrequency.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
allowCreateWorkOrder	(bool) Allow Create Work Order.
notificationSent	(bool) Notification Sent.

The following elements are optional:

workOrder	(string) Work Order. (fk) Allowed value: the natural key of a record of type WorkOrder. These records are accessibly through the WorkOrders service.
isDelayed	(bool) Is Delayed.
fixedDate	(DateTimeOffset) Fixed Date.
projectionWorkOrders	(List of ProjectionWorkOrderResource) Preventive Maint. Events. See ProjectionWorkOrderResource.
meterCumulativeReading	(decimal) Meter Cumulative Reading.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

RecurrenceFrequency

1	Daily
2	Weekly
3	Monthly
4	Yearly