Work | Preventive Maintenances

Service to manage entities of type 'PreventiveMaintenance'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET PreventiveMaintenances (odata)
  • GET PreventiveMaintenance by identifier
  • GET PreventiveMaintenance by key
  • GET Get Current Schema Entity State
  • GET Get Preventive Maintenance State Transitions
• POST:
  • POST PreventiveMaintenances
  • POST Preventive Maintenance Plan
  • POST Get Preventive Maintenance Recurrence Dates
  • POST Reschedule Preventive Maintenances
  • POST Change Schema Entity State
• PUT:
  • PUT Set Custom Attribute PreventiveMaintenance
  • PUT Set Custom Attribute PreventiveMaintenancePlan
  • PUT Set IsActive PreventiveMaintenance
  • PUT Set PreventiveMaintenanceKey PreventiveMaintenance
  • PUT Set Numerator PreventiveMaintenance
  • PUT Set PreventiveMaintenanceVersion PreventiveMaintenance
  • PUT Set Description PreventiveMaintenance
  • PUT Set SchemaEntityState PreventiveMaintenance
  • PUT Set WorkOrderType PreventiveMaintenance
  • PUT Set Workshop PreventiveMaintenance
  • PUT Set Responsible PreventiveMaintenance
  • PUT Set PriorityLevel PreventiveMaintenance
  • PUT Set Company PreventiveMaintenance
  • PUT Set OpenWOAuthorization PreventiveMaintenance
  • PUT Set CloseWOAuthorization PreventiveMaintenance
  • PUT Set SimplifiedReporting PreventiveMaintenance
  • PUT Set Remarks PreventiveMaintenance
  • PUT Set ProjectionEndDate PreventiveMaintenance
  • PUT Set JoinPlans PreventiveMaintenance
  • PUT Set Customer PreventiveMaintenance
  • PUT Set Provider PreventiveMaintenance
  • PUT Set RescheduleLog PreventiveMaintenance
  • PUT Set RescheduleDate PreventiveMaintenance
  • PUT Set RescheduleResult PreventiveMaintenance
  • PUT Set WorkOrderState PreventiveMaintenance
  • PUT Set SchedulingCriteria PreventiveMaintenance
  • PUT Set CurrentStateId PreventiveMaintenance
  • PUT Set TimeZoneId PreventiveMaintenance
  • PUT Set TimeZoneDescription PreventiveMaintenance
  • PUT Set AllowPreviewEvents PreventiveMaintenance
  • PUT Set AllowRescheduleEvents PreventiveMaintenance
  • PUT Set AllowCreateNewVersion PreventiveMaintenance
  • PUT Set TemplateParameters PreventiveMaintenance
  • PUT Set NotificationWorkshopId PreventiveMaintenance
  • PUT Set NewStateId PreventiveMaintenance
  • PUT Set PreviousStateId PreventiveMaintenance
  • PUT Set IsLocked PreventiveMaintenance
  • PUT Set ReferenceCalendar PreventiveMaintenance
  • PUT Set WorkCalendar PreventiveMaintenance
  • PUT Set ReferenceTimeSchedule PreventiveMaintenance
  • PUT Set WorkTimeSchedule PreventiveMaintenance
  • PUT Set MaintenancePlan PreventiveMaintenancePlan
  • PUT Set RecurrenceConfig PreventiveMaintenancePlan
  • PUT Set AdvanceTolerance PreventiveMaintenancePlan
  • PUT Set DelayTolerance PreventiveMaintenancePlan
  • PUT Set OperatingState PreventiveMaintenancePlan
  • PUT Set ReplacementCriteria PreventiveMaintenancePlan
  • PUT Set MainMaintenancePlan PreventiveMaintenancePlan
  • PUT Set Events PreventiveMaintenancePlan
  • PUT Set ReplacementStart PreventiveMaintenancePlan
  • PUT Set MainPlanId PreventiveMaintenancePlan
  • PUT Set MainPlan PreventiveMaintenancePlan
  • PUT Set MainPlanDescription PreventiveMaintenancePlan
  • PUT Set Meter PreventiveMaintenancePlan
  • PUT Set Interval PreventiveMaintenancePlan
  • PUT Set StartValue PreventiveMaintenancePlan
  • PUT Set MeterLastValue PreventiveMaintenancePlan
  • PUT Set MeterAverage PreventiveMaintenancePlan
  • PUT Set MeterStartValue PreventiveMaintenancePlan
  • PUT Set ExpectedDuration PreventiveMaintenancePlan
  • PUT Set ExpectedDurationSeconds PreventiveMaintenancePlan
• DELETE:
  • DELETE Preventive Maintenance Plan by identifier
  • DELETE PreventiveMaintenance by identifier
  • DELETE PreventiveMaintenance by key

All Resources

This service uses the following resources:

• ApiPreventiveMaintenancePreventiveMaintenancePlansResource
• ApiPreventiveMaintenanceResource
• ChangePreventiveSchemaEntityStateReturnResource
• PreventiveMaintenancePlanResource
• PreventiveMaintenanceRecurrenceDate
• PreventiveMaintenanceResource
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AssetType
• ReferenceCalendar
• ReferenceTimeSchedule
• ReplacementCriteria
• RescheduleResult
• SchedulingCriteria

GET Operations

GET PreventiveMaintenances (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 PreventiveMaintenanceResource.

Response status codes:

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

Resource URL:

GET PreventiveMaintenance 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 PreventiveMaintenanceResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.

Response:

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

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 Get Current Schema Entity State

Custom operation 'GetCurrentSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
preventiveMaintenanceKey	(string) PreventiveMaintenanceKey.

Response:

When successful, the response body contains a resource of type 'PreventiveMaintenanceResource'. See PreventiveMaintenanceResource.

Response status codes:

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

Resource URL:

GET Get Preventive Maintenance State Transitions

Custom operation 'GetPreventiveMaintenanceStateTransitions'.

The following elements are required:

preventiveMaintenanceKey

(string) PreventiveMaintenanceKey.

Response:

When successful, the response body contains a list of resources of type 'PreventiveMaintenanceResource'. See PreventiveMaintenanceResource.

Response status codes:

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

Resource URL:

POST Operations

POST PreventiveMaintenances

Creates a new entity record.

The following elements are required:

preventiveMaintenanceResource

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

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

Response status codes:

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

Resource URL:

POST Preventive Maintenance Plan

Inserts a new 'Preventive Maintenance Plan' in the 'Preventive Maintenance'.

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(ApiPreventiveMaintenancePreventiveMaintenancePlansResource) The ApiPreventiveMaintenancePreventiveMaintenancePlansResource instance. See ApiPreventiveMaintenancePreventiveMaintenancePlansResource.

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 Preventive Maintenance Recurrence Dates

Custom operation 'GetPreventiveMaintenanceRecurrenceDates'.

The following elements are required:

preventiveMaintenanceKey	(string) PreventiveMaintenanceKey.
maintenancePlanKey	(string) MaintenancePlanKey.
startDate	(DateTimeOffset) StartDate.
endDate	(DateTimeOffset) EndDate.

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 'PreventiveMaintenanceRecurrenceDate'. See PreventiveMaintenanceRecurrenceDate.

Resource URL:

POST Reschedule Preventive Maintenances

Custom operation 'ReschedulePreventiveMaintenances'.

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 Change Schema Entity State

Custom operation 'ChangeSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
preventiveMaintenanceKey	(string) PreventiveMaintenanceKey.
schemaEntityStateKey	(string) SchemaEntityStateKey.
stateJustificationKey	(string) StateJustificationKey.
stateJustificationTypeKey	(string) StateJustificationTypeKey.
stateJustificationRemarks	(string) StateJustificationRemarks.

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 'ChangePreventiveSchemaEntityStateReturnResource'. See ChangePreventiveSchemaEntityStateReturnResource.

Resource URL:

PUT Operations

PUT Set AdvanceTolerance PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 AllowCreateNewVersion PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 AllowPreviewEvents PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 AllowRescheduleEvents PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 CloseWOAuthorization PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 CurrentStateId PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Customer PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 DelayTolerance PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Description PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Events PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 ExpectedDuration PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(TimeSpan) 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 ExpectedDurationSeconds PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Interval PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
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 IsActive PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 IsLocked PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 JoinPlans PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MainMaintenancePlan PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MainPlan PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MainPlanDescription PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MainPlanId PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MaintenancePlan PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Meter PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 MeterAverage PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
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 MeterLastValue PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
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 MeterStartValue PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
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 NewStateId PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 NotificationWorkshopId PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Numerator PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 OpenWOAuthorization PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 OperatingState PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreventiveMaintenanceKey PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreventiveMaintenanceVersion PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreviousStateId PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PriorityLevel PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 ProjectionEndDate PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(DateTime) 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 Provider PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 RecurrenceConfig PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 ReferenceCalendar PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(enum ReferenceCalendar) The request body should contain the new value for the attribute. See ReferenceCalendar.

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 ReferenceTimeSchedule PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(enum ReferenceTimeSchedule) The request body should contain the new value for the attribute. See ReferenceTimeSchedule.

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 PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 ReplacementCriteria PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum ReplacementCriteria) The request body should contain the new value for the attribute. See ReplacementCriteria.

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 ReplacementStart PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 RescheduleDate PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 RescheduleLog PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 RescheduleResult PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(enum RescheduleResult) The request body should contain the new value for the attribute. See RescheduleResult.

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 Responsible PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 SchedulingCriteria PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
companyKey	(string) The company key.
value	(enum SchedulingCriteria) The request body should contain the new value for the attribute. See SchedulingCriteria.

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 SchemaEntityState PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 SimplifiedReporting PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 StartValue PreventiveMaintenancePlan

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
lineId	(string) The detail identifier.
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 TemplateParameters PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 TimeZoneDescription PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 TimeZoneId PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 WorkCalendar PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 WorkOrderState PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 WorkOrderType PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 Workshop PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 WorkTimeSchedule PreventiveMaintenance

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

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreventiveMaintenance

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

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenanceKey	(string) Preventive Maintenance
numerator	(int) Numerator
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 PreventiveMaintenancePlan

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

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenanceKey	(string) Preventive Maintenance
numerator	(int) Numerator
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 Preventive Maintenance Plan by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
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 PreventiveMaintenance 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 PreventiveMaintenance by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.

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

ApiPreventiveMaintenancePreventiveMaintenancePlansResource

The following elements are required:

maintenancePlan	(string) Maintenance Plan.
advanceTolerance	(int) Advance Tolerance.
delayTolerance	(int) Delay Tolerance.

The following elements are optional:

recurrenceConfig	(string) Recurrence Config.
operatingState	(string) Operating State.
replacementCriteria	(enum ReplacementCriteria) Replacement Criteria. See ReplacementCriteria.
mainMaintenancePlan	(string) Main Plan.
events	(int) Events.
replacementStart	(int) Start at.
mainPlanId	(Guid) Main Plan Id.
mainPlan	(string) Main Plan.
mainPlanDescription	(string) Main Plan Description.
meter	(string) Meter.
interval	(decimal) Interval.
startValue	(decimal) Start Value.
meterLastValue	(decimal) Meter Last Value.
meterAverage	(decimal) Meter Average.
meterStartValue	(decimal) Meter Start Value.
expectedDuration	(TimeSpan) Expected Duration.
expectedDurationSeconds	(int) Expected Duration Seconds.

ApiPreventiveMaintenanceResource

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
preventiveMaintenanceVersion	(int) Version.
description	(string) Description.
schemaEntityState	(string) State.
workOrderType	(string) WO Type.
workshop	(string) Workshop.
assetType	(enum AssetType) Type. See AssetType.
priorityLevel	(string) Priority Level.
company	(string) Company.
openWOAuthorization	(bool) If true the system only allows the work order to be opened after an authorization has been granted.
closeWOAuthorization	(bool) If true the system only allows the work order to be closed after an authorization has been granted.
simplifiedReporting	(bool) If true the system will report automatically the items and labor associated to the work order tasks.
joinPlans	(bool) Join Plans.
schedulingCriteria	(enum SchedulingCriteria) Scheduling. See SchedulingCriteria.
timeZoneId	(string) Time Zone.
allowPreviewEvents	(bool) Allow Preview Events.
allowRescheduleEvents	(bool) Allow Reschedule Events.
allowCreateNewVersion	(bool) Allow Create New Version.
newStateId	(Guid) New State Id.

The following elements are optional:

responsible	(string) Person In Charge.
parentLocation	(string) Parent Location.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
maintenanceRoute	(string) Route.
remarks	(string) Remarks.
preventiveMaintenancePlans	(List of ApiPreventiveMaintenancePreventiveMaintenancePlansResource) Maintenance Plans. See ApiPreventiveMaintenancePreventiveMaintenancePlansResource.
projectionEndDate	(DateTime) Projection End.
customer	(string) Customer.
provider	(string) Supplier.
rescheduleLog	(string) Log.
rescheduleDate	(DateTimeOffset) Date.
rescheduleResult	(enum RescheduleResult) Result. See RescheduleResult.
workOrderState	(string) WO State.
currentStateId	(Guid) Current State Id.
timeZoneDescription	(string) Time Zone.
templateParameters	(string) Template Parameters.
notificationWorkshopId	(Guid) Notification Workshop Id.
previousStateId	(Guid) Previous State Id.
isLocked	(bool) Is Locked.
referenceCalendar	(enum ReferenceCalendar) Reference Calendar. See ReferenceCalendar.
workCalendar	(string) Calendar.
referenceTimeSchedule	(enum ReferenceTimeSchedule) Reference Time Schedule. See ReferenceTimeSchedule.
workTimeSchedule	(string) Time Schedule.
preventiveMaintenanceEventKey	(string) Preventive Maintenance Event Key.
predictedDate	(DateTimeOffset) Predicted Date.
maintenancePlanKey	(string) Maintenance Plan Key.
maintenancePlan	(string) Maintenance Plan.

ChangePreventiveSchemaEntityStateReturnResource

The following elements are required:

allowPreviewEvents	(bool) Allow Preview Events.
allowRescheduleEvents	(bool) Allow Reschedule Events.
allowCreateNewVersion	(bool) Allow Create New Version.

The following elements are optional:

message

(string) Message.

PreventiveMaintenancePlanResource

The following elements are required:

maintenancePlan	(string) Maintenance Plan.
advanceTolerance	(int) Advance Tolerance.
delayTolerance	(int) Delay Tolerance.

The following elements are optional:

recurrenceConfig	(string) Recurrence Config.
operatingState	(string) Operating State.
replacementCriteria	(enum ReplacementCriteria) Replacement Criteria. See ReplacementCriteria.
mainMaintenancePlan	(string) Main Plan.
events	(int) Events.
replacementStart	(int) Start at.
mainPlanId	(Guid) Main Plan Id.
mainPlan	(string) Main Plan.
mainPlanDescription	(string) Main Plan Description.
meter	(string) Meter.
interval	(decimal) Interval.
startValue	(decimal) Start Value.
meterLastValue	(decimal) Meter Last Value.
meterAverage	(decimal) Meter Average.
meterStartValue	(decimal) Meter Start Value.
expectedDuration	(TimeSpan) Expected Duration.
expectedDurationSeconds	(int) Expected Duration Seconds.

PreventiveMaintenanceRecurrenceDate

The following elements are required:

maintenancePlanKey	(string) Maintenance Plan Key.
recurrenceDate	(DateTimeOffset) Recurrence Date.

The following elements are optional:

preventiveMaintenancePlanId

(Guid) Preventive Maintenance Plan Id.

PreventiveMaintenanceResource

The following elements are required:

preventiveMaintenanceKey	(string) Preventive Maintenance.
numerator	(int) Numerator.
preventiveMaintenanceVersion	(int) Version.
description	(string) Description.
schemaEntityState	(string) State.
workOrderType	(string) WO Type.
workshop	(string) Workshop.
assetType	(enum AssetType) Type. See AssetType.
priorityLevel	(string) Priority Level.
company	(string) Company.
openWOAuthorization	(bool) If true the system only allows the work order to be opened after an authorization has been granted.
closeWOAuthorization	(bool) If true the system only allows the work order to be closed after an authorization has been granted.
simplifiedReporting	(bool) If true the system will report automatically the items and labor associated to the work order tasks.
joinPlans	(bool) Join Plans.
schedulingCriteria	(enum SchedulingCriteria) Scheduling. See SchedulingCriteria.
timeZoneId	(string) Time Zone.
allowPreviewEvents	(bool) Allow Preview Events.
allowRescheduleEvents	(bool) Allow Reschedule Events.
allowCreateNewVersion	(bool) Allow Create New Version.
newStateId	(Guid) New State Id.

The following elements are optional:

responsible	(string) Person In Charge.
parentLocation	(string) Parent Location.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
maintenanceRoute	(string) Route.
remarks	(string) Remarks.
preventiveMaintenancePlans	(List of PreventiveMaintenancePlanResource) Maintenance Plans. See PreventiveMaintenancePlanResource.
projectionEndDate	(DateTime) Projection End.
customer	(string) Customer.
provider	(string) Supplier.
rescheduleLog	(string) Log.
rescheduleDate	(DateTimeOffset) Date.
rescheduleResult	(enum RescheduleResult) Result. See RescheduleResult.
workOrderState	(string) WO State.
currentStateId	(Guid) Current State Id.
timeZoneDescription	(string) Time Zone.
templateParameters	(string) Template Parameters.
notificationWorkshopId	(Guid) Notification Workshop Id.
previousStateId	(Guid) Previous State Id.
isLocked	(bool) Is Locked.
referenceCalendar	(enum ReferenceCalendar) Reference Calendar. See ReferenceCalendar.
workCalendar	(string) Calendar.
referenceTimeSchedule	(enum ReferenceTimeSchedule) Reference Time Schedule. See ReferenceTimeSchedule.
workTimeSchedule	(string) Time Schedule.
preventiveMaintenanceEventKey	(string) Preventive Maintenance Event Key.
predictedDate	(DateTimeOffset) Predicted Date.
maintenancePlanKey	(string) Maintenance Plan Key.
maintenancePlan	(string) Maintenance Plan.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AssetType

1	Location
2	Equipment
3	Tool
4	Route

ReferenceCalendar

1	CompanyDefault
2	Other

ReferenceTimeSchedule

1	CompanyDefault
2	Other

ReplacementCriteria

1	Multiplier
3	Replacement

RescheduleResult

1	Success
2	Error

SchedulingCriteria

1	FixedDate
2	OpeningDate
3	ClosingDate