Work | Work Order

Service to manage entities of type 'WorkOrder'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET WorkOrders (odata)
  • GET WorkOrder by identifier
  • GET WorkOrder by key
  • GET Get Work Orders For Request
  • GET Get Work Order Costs Summary
  • GET Get Work Orders Finalized Assigned To Employee
  • GET Get Work Orders Canceled Assigned To Employee
  • GET Get Workorders Attachements Assets
  • GET Get Work Orders Assigned To Employee
  • GET Get Current Schema Entity State
  • GET Get State Transitions
  • GET Get Subscription Asset Types
  • GET Get Work Order Filter
  • GET Get Work Orders Canceled Closed By Employee
• POST:
  • POST WorkOrders
  • POST Work Order Maintenance Plan
  • POST Work Order Task
  • POST Work Order Note
  • POST Change State
  • POST Build Work Order For Request
  • POST Change SLA
  • POST Change Request State To
  • POST Validate Down And Up Times Histories Transition Dates
  • POST New Work Order Info
  • POST Change Work Order State
  • POST Update Work Order Info
  • POST Change Schema Entity State
  • POST Add Unassignments Tasks
  • POST Add Assignments Tasks
  • POST Add Change State Tasks
  • POST Monitor Change State Tasks
  • POST Automatic Close Work Orders
  • POST Add Only Print Task
  • POST Send SLA End Date Notification
• PUT:
  • PUT Set Custom Attribute WorkOrder
  • PUT Set Custom Attribute WorkOrderMaintenancePlan
  • PUT Set Custom Attribute WorkOrderTask
  • PUT Set IsActive WorkOrder
  • PUT Set ExchangeRate WorkOrder
  • PUT Set WorkOrderKey WorkOrder
  • PUT Set Description WorkOrder
  • PUT Set Date WorkOrder
  • PUT Set WorkOrderType WorkOrder
  • PUT Set AssetType WorkOrder
  • PUT Set Equipment WorkOrder
  • PUT Set Tool WorkOrder
  • PUT Set Location WorkOrder
  • PUT Set MaintenanceRoute WorkOrder
  • PUT Set PriorityLevel WorkOrder
  • PUT Set Remarks WorkOrder
  • PUT Set EquipmentUnderWarranty WorkOrder
  • PUT Set LocationShutdown WorkOrder
  • PUT Set EquipmentShutdown WorkOrder
  • PUT Set IsPrinted WorkOrder
  • PUT Set AutoOpenWO WorkOrder
  • PUT Set ProcessReturns WorkOrder
  • PUT Set ExpectedDuration WorkOrder
  • PUT Set ActualDuration WorkOrder
  • PUT Set ParentLocation WorkOrder
  • PUT Set Responsible WorkOrder
  • PUT Set Workshop WorkOrder
  • PUT Set SchemaEntityState WorkOrder
  • PUT Set CurrentStateId WorkOrder
  • PUT Set ExpectedDate WorkOrder
  • PUT Set ExpectedEndDate WorkOrder
  • PUT Set SLAStartDate WorkOrder
  • PUT Set SLAEndDate WorkOrder
  • PUT Set SourceRequestId WorkOrder
  • PUT Set TriggerStateId WorkOrder
  • PUT Set Company WorkOrder
  • PUT Set AllowWorkReport WorkOrder
  • PUT Set AllowCostReport WorkOrder
  • PUT Set AllowAssignments WorkOrder
  • PUT Set AllowChangeTransitions WorkOrder
  • PUT Set OperatingState WorkOrder
  • PUT Set IsDownOperatingState WorkOrder
  • PUT Set ApplyDownTimeChildren WorkOrder
  • PUT Set AllowChangeOperatingState WorkOrder
  • PUT Set AllowDownTime WorkOrder
  • PUT Set PreventiveMaintenanceEventId WorkOrder
  • PUT Set ReportDownTime WorkOrder
  • PUT Set ExpectedDurationSeconds WorkOrder
  • PUT Set ActualDurationSeconds WorkOrder
  • PUT Set CloseDowntime WorkOrder
  • PUT Set AssetHaveChildrens WorkOrder
  • PUT Set HasPendingDownTime WorkOrder
  • PUT Set TemplateParameters WorkOrder
  • PUT Set NotificationResponsibleId WorkOrder
  • PUT Set NotificationWorkshopId WorkOrder
  • PUT Set AssignedToIds WorkOrder
  • PUT Set NewStateId WorkOrder
  • PUT Set PreviousStateId WorkOrder
  • PUT Set SubscriptionAssetTypeId WorkOrder
  • PUT Set ReportLang WorkOrder
  • PUT Set FromApi WorkOrder
  • PUT Set ExpectedCost WorkOrder
  • PUT Set ActualCost WorkOrder
  • PUT Set Currency WorkOrder
  • PUT Set ExchangeRateDate WorkOrder
  • PUT Set Supplier WorkOrder
  • PUT Set Customer WorkOrder
  • PUT Set SourceWorkOrder WorkOrder
  • PUT Set ApplyDefaults WorkOrder
  • PUT Set SourceRequestAssetTypeId WorkOrder
  • PUT Set IsAssetLocked WorkOrder
  • PUT Set MaintenancePlan WorkOrderMaintenancePlan
  • PUT Set Remarks WorkOrderMaintenancePlan
  • PUT Set MaintenancePlanType WorkOrderMaintenancePlan
  • PUT Set Workshop WorkOrderMaintenancePlan
  • PUT Set Task WorkOrderTask
  • PUT Set PredictedDate WorkOrderTask
  • PUT Set Duration WorkOrderTask
  • PUT Set TimeUnit WorkOrderTask
  • PUT Set Remarks WorkOrderTask
  • PUT Set Workshop WorkOrderTask
• DELETE:
  • DELETE Work Order Maintenance Plan by identifier
  • DELETE Work Order Task by identifier
  • DELETE Work Order Note by identifier
  • DELETE WorkOrder by identifier
  • DELETE WorkOrder by key

All Resources

This service uses the following resources:

• ApiWorkOrderResource
• ApiWorkOrderWorkOrderMaintenancePlansResource
• ApiWorkOrderWorkOrderMaintenancePlansWorkOrderPlanTasksResource
• ApiWorkOrderWorkOrderNotesResource
• ApiWorkOrderWorkOrderTasksResource
• ChangeSchemaEntityStateReturnResource
• ChangeStateTasksContext
• CostsSummary
• MoneyResource
• OnlyPrintTask
• StateSLA
• SubscriptionAssetType
• WorkOrderAssignedToEmployeeResource
• WorkOrderAssignmentsTask
• WorkOrderCanceledClosedByEmployeeResource
• WorkOrderChangeStateTask
• WorkOrderFilterResource
• WorkOrderInfoResource
• WorkOrderMaintenancePlanResource
• WorkOrderMaintenancePlanTaskResource
• WorkOrderNoteResource
• WorkOrderResource
• WorkOrderResourceResource
• WorkOrderResourceWorkOrderMaintenancePlansResource
• WorkOrderResourceWorkOrderNotesResource
• WorkOrderResourceWorkOrderTasksResource
• WorkordersAttachementsAsset
• WorkOrderStateInfo
• WorkOrdersToCloseResource
• WorkOrderTaskResource
• WorkOrderUnassignmentsTask
• ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

• AssetType
• VisibleTo

GET Operations

GET WorkOrders (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 WorkOrderResource.

Response status codes:

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

Resource URL:

GET WorkOrder 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 WorkOrderResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderKey	(string) Work Order.

Response:

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

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 Work Orders For Request

Gets the work orders for request.

The following elements are required:

requestId

(Guid) RequestId.

Response:

When successful, the response body contains a list of unique identifiers.

Response status codes:

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

Resource URL:

GET Get Work Order Costs Summary

Custom operation 'GetWorkOrderCostsSummary'.

The following elements are required:

code	(string) Code.
months	(int) Months.

Response:

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

Response status codes:

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

Resource URL:

GET Get Work Orders Finalized Assigned To Employee

Custom operation 'GetWorkOrdersFinalizedAssignedToEmployee'.

The following elements are required:

version	(string) Version.
modifiedOn	(DateTimeOffset) ModifiedOn.
assignedTo	(string) AssignedTo.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
company	(string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET Get Work Orders Canceled Assigned To Employee

Custom operation 'GetWorkOrdersCanceledAssignedToEmployee'.

The following elements are required:

version	(string) Version.
modifiedOn	(DateTimeOffset) ModifiedOn.
assignedTo	(string) AssignedTo.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
company	(string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET Get Workorders Attachements Assets

Custom operation 'GetWorkordersAttachementsAssets'.

The following elements are required:

version	(string) Version.
modifiedOn	(DateTimeOffset) ModifiedOn.
assignedTo	(string) AssignedTo.
stateKey	(string) StateKey.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
company	(string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET Get Work Orders Assigned To Employee

Custom operation 'GetWorkOrdersAssignedToEmployee'.

The following elements are required:

version	(string) Version.
modifiedOn	(DateTimeOffset) ModifiedOn.
assignedTo	(string) AssignedTo.
stateKey	(string) StateKey.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
company	(string) Company.

Response:

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

Response status codes:

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

Resource URL:

GET Get Current Schema Entity State

Custom operation 'GetCurrentSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderKey	(string) WorkOrderKey.

Response:

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

Response status codes:

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

Resource URL:

GET Get State Transitions

Custom operation 'GetStateTransitions'.

The following elements are required:

workOrderKey

(string) WorkOrderKey.

Response:

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

Response status codes:

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

Resource URL:

GET Get Subscription Asset Types

Custom operation 'GetSubscriptionAssetTypes'.

Response:

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

Response status codes:

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

Resource URL:

GET Get Work Order Filter

Custom operation 'GetWorkOrderFilter'.

The following elements are required:

version	(string) Version.
modifiedOn	(DateTimeOffset) ModifiedOn.
stateKey	(string) StateKey.
expectedDate	(DateTimeOffset) ExpectedDate.
date	(DateTimeOffset) Date.
dateTransition	(DateTimeOffset) DateTransition.
maxRecords	(int) MaxRecords.
attachments	(bool) Attachments.

Response:

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

Response status codes:

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

Resource URL:

GET Get Work Orders Canceled Closed By Employee

Custom operation 'GetWorkOrdersCanceledClosedByEmployee'.

The following elements are required:

modifiedOn	(DateTimeOffset) modifiedOn.
assignedTo	(string) AssignedTo.
maxRecords	(int) MaxRecords.
daysLimit	(int) DaysLimit.
company	(string) Company.

Response:

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

Response status codes:

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

Resource URL:

POST Operations

POST WorkOrders

Creates a new entity record.

The following elements are required:

workOrderResource

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

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

Response status codes:

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

Resource URL:

POST Work Order Maintenance Plan

Inserts a new 'Work Order Maintenance Plan' in the 'Work Order'.

The following elements are required:

workOrderKey	(string) Work Order.
companyKey	(string) The company key.
value	(ApiWorkOrderWorkOrderMaintenancePlansResource) The ApiWorkOrderWorkOrderMaintenancePlansResource instance. See ApiWorkOrderWorkOrderMaintenancePlansResource.

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 Work Order Task

Inserts a new 'Work Order Task' in the 'Work Order'.

The following elements are required:

workOrderKey	(string) Work Order.
companyKey	(string) The company key.
value	(ApiWorkOrderWorkOrderTasksResource) The ApiWorkOrderWorkOrderTasksResource instance. See ApiWorkOrderWorkOrderTasksResource.

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 Work Order Note

Inserts a new 'Work Order Note' in the 'Work Order'.

The following elements are required:

workOrderKey	(string) Work Order.
companyKey	(string) The company key.
value	(ApiWorkOrderWorkOrderNotesResource) The ApiWorkOrderWorkOrderNotesResource instance. See ApiWorkOrderWorkOrderNotesResource.

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

Changes the request state.

The following elements are required:

workOrderId	(Guid) WorkOrderId.
newStateId	(Guid) NewStateId.
triggerStateId	(Guid) TriggerStateId.
requestId	(Guid) RequestId.

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 'boolean'.

Resource URL:

POST Build Work Order For Request

Custom operation 'BuildWorkOrderForRequest'.

The following elements are required:

sourceRequestId	(Guid) SourceRequestId.
assetType	(string) AssetType.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
assetRoute	(string) AssetRoute.
parentLocation	(string) ParentLocation.
priorityLevel	(string) PriorityLevel.
description	(string) Description.
remarks	(string) Remarks.
operatingState	(string) OperatingState.
workshop	(string) Workshop.
workOrderType	(string) WorkOrderType.
maintenancePlan	(string) MaintenancePlan.
expectedDate	(DateTimeOffset) ExpectedDate.
expectedEndDate	(DateTimeOffset) ExpectedEndDate.

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

Resource URL:

POST Change SLA

Custom operation 'ChangeSLA'.

The following elements are required:

workOrderId	(Guid) WorkOrderId.
statesSLA	(List) StatesSLA.
requestId	(Guid) RequestId.

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 'boolean'.

Resource URL:

POST Change Request State To

Custom operation 'ChangeRequestStateTo'.

The following elements are required:

schemaEntityStateId

(Guid) SchemaEntityStateId.

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 unique identifier.

Resource URL:

POST Validate Down And Up Times Histories Transition Dates

Custom operation 'ValidateDownAndUpTimesHistoriesTransitionDates'.

The following elements are required:

workOrderId	(Guid) WorkOrderId.
transitionDates	(List) TransitionDates.

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 'boolean'.

Resource URL:

POST New Work Order Info

Custom operation 'NewWorkOrderInfo'.

The following elements are required:

workOrderInfo

(WorkOrderInfoResource) WorkOrderInfo.

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

Resource URL:

POST Change Work Order State

Custom operation 'ChangeWorkOrderState'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderStates	(List) WorkOrderStates.

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

Resource URL:

POST Update Work Order Info

Custom operation 'UpdateWorkOrderInfo'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderKey	(string) WorkOrderKey.
workOrderInfo	(WorkOrderInfoResource) WorkOrderInfo.

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

Resource URL:

POST Change Schema Entity State

Custom operation 'ChangeSchemaEntityState'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderKey	(string) WorkOrderKey.
schemaEntityStateKey	(string) SchemaEntityStateKey.
applyDowntimeToChildren	(bool) ApplyDowntimeToChildren.
closeDowntime	(bool) CloseDowntime.
stateJustificationKey	(string) StateJustificationKey.
stateJustificationTypeKey	(string) StateJustificationTypeKey.
stateJustificationRemarks	(string) StateJustificationRemarks.
stateChangeDate	(DateTimeOffset) StateChangeDate.

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

Resource URL:

POST Add Unassignments Tasks

Custom operation 'AddUnassignmentsTasks'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderUnassignmentsTask	(List) WorkOrderUnassignmentsTask.
notifyOnStart	(bool) NotifyOnStart.
notifyOnEnd	(bool) NotifyOnEnd.

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

Resource URL:

POST Add Assignments Tasks

Custom operation 'AddAssignmentsTasks'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderAssignmentsTasks	(List) WorkOrderAssignmentsTasks.
notifyOnStart	(bool) NotifyOnStart.
notifyOnEnd	(bool) NotifyOnEnd.

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

Resource URL:

POST Add Change State Tasks

Custom operation 'AddChangeStateTasks'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderChangeStateTasks	(List) WorkOrderChangeStateTasks.
notifyOnStart	(bool) NotifyOnStart.
notifyOnEnd	(bool) NotifyOnEnd.
duplexPrinting	(bool) DuplexPrinting.

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

Resource URL:

POST Monitor Change State Tasks

Custom operation 'MonitorChangeStateTasks'.

The following elements are required:

context

(ChangeStateTasksContext) Context.

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 'boolean'.

Resource URL:

POST Automatic Close Work Orders

Custom operation 'AutomaticCloseWorkOrders'.

The following elements are required:

isAzurefunction

(bool) IsAzurefunction.

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 'boolean'.

Resource URL:

POST Add Only Print Task

Custom operation 'AddOnlyPrintTask'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderOnlyPrintTask	(List) WorkOrderOnlyPrintTask.
templateReport	(string) TemplateReport.
notifyOnEnd	(bool) NotifyOnEnd.

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

Resource URL:

POST Send SLA End Date Notification

Custom operation 'SendSLAEndDateNotification'.

The following elements are required:

companyKey	(string) CompanyKey.
workOrderKey	(string) WorkOrderKey.
notificationKey	(string) NotificationKey.

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 'boolean'.

Resource URL:

PUT Operations

PUT Set ActualCost WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ActualDuration WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ActualDurationSeconds WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowAssignments WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowChangeOperatingState WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowChangeTransitions WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowCostReport WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowDownTime WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AllowWorkReport WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ApplyDefaults WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ApplyDownTimeChildren WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AssetHaveChildrens WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AssetType WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
companyKey	(string) The company key.
value	(enum AssetType) The request body should contain the new value for the attribute. See AssetType.

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 AssignedToIds WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 AutoOpenWO WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 CloseDowntime WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Currency WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Date WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Description WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Duration WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Equipment WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 EquipmentShutdown WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 EquipmentUnderWarranty WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExchangeRate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExchangeRateDate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExpectedCost WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExpectedDate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExpectedDuration WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ExpectedEndDate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 FromApi WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 HasPendingDownTime WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT Set IsActive WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 IsAssetLocked WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 IsDownOperatingState WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 IsPrinted WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Location WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 LocationShutdown WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 MaintenancePlan WorkOrderMaintenancePlan

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

The following elements are required:

workOrderKey	(string) Work Order.
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 MaintenancePlanType WorkOrderMaintenancePlan

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

The following elements are required:

workOrderKey	(string) Work Order.
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 MaintenanceRoute WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 NewStateId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 NotificationResponsibleId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 OperatingState WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ParentLocation WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 PredictedDate WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
lineId	(string) The detail identifier.
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 PreventiveMaintenanceEventId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 PreviousStateId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ProcessReturns WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Remarks WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Remarks WorkOrderMaintenancePlan

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Remarks WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ReportDownTime WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 ReportLang WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Responsible WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SchemaEntityState WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SLAEndDate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SLAStartDate WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SourceRequestAssetTypeId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SourceRequestId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SourceWorkOrder WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 SubscriptionAssetTypeId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Supplier WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Task WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
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 TemplateParameters WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 TimeUnit WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Tool WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 TriggerStateId WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrderKey WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrderMaintenancePlan

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

The following elements are required:

workOrderKey	(string) Work Order.
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 Workshop WorkOrderTask

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

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder

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

The following elements are required:

companyKey	(string) The company key.
workOrderKey	(string) Work Order
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 WorkOrderMaintenancePlan

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

The following elements are required:

companyKey	(string) The company key.
workOrderKey	(string) Work Order
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 Set Custom Attribute WorkOrderTask

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

The following elements are required:

companyKey	(string) The company key.
workOrderKey	(string) Work Order
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 Work Order Maintenance Plan by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workOrderKey	(string) Work Order.
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 Work Order Task by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workOrderKey	(string) Work Order.
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 Work Order Note by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workOrderKey	(string) Work Order.
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 WorkOrder 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 WorkOrder by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
workOrderKey	(string) Work Order.

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

ApiWorkOrderResource

The following elements are required:

exchangeRate	(decimal) Exchange Rate.
workOrderKey	(string) Work Order.
description	(string) Description.
date	(DateTimeOffset) Date.
workOrderType	(string) WO Type.
assetType	(enum AssetType) Type. See AssetType.
schemaEntityState	(string) State.
expectedDate	(DateTimeOffset) Expected Date.
company	(string) Company.
allowWorkReport	(bool) Allow Work Report.
allowCostReport	(bool) Allow Cost Report.
allowAssignments	(bool) Allow Assignments.
allowChangeTransitions	(bool) Allow Change Transitions.
isDownOperatingState	(bool) Is Down Operating State.
applyDownTimeChildren	(bool) Apply down time to children.
allowChangeOperatingState	(bool) Allow Change Operating State.
allowDownTime	(bool) Allow Down Time.
reportDownTime	(bool) Indicates to report down time.
closeDowntime	(bool) Close Downtime.
assetHaveChildrens	(bool) Asset Have Children.
hasPendingDownTime	(bool) Has Pending Down Time.
newStateId	(Guid) New State Id.
subscriptionAssetTypeId	(int) Type.
fromApi	(bool) From Api.
expectedCost	(MoneyResource) Expected Cost. See MoneyResource .
actualCost	(MoneyResource) Actual Cost. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

equipment	(string) Equipment.
tool	(string) Tool.
location	(string) Location.
maintenanceRoute	(string) Route.
priorityLevel	(string) Priority Level.
remarks	(string) Remarks.
equipmentUnderWarranty	(bool) Equipment Under Warranty.
locationShutdown	(string) Location Shutdown.
equipmentShutdown	(string) Equipment Shutdown.
isPrinted	(bool) Is Printed.
autoOpenWO	(bool) Auto Open WO.
processReturns	(bool) Process Returns.
expectedDuration	(TimeSpan) Expected Duration.
actualDuration	(TimeSpan) Actual Duration.
parentLocation	(string) Parent Location.
responsible	(string) Person In Charge.
workshop	(string) Workshop.
currentStateId	(Guid) Current State Id.
expectedEndDate	(DateTimeOffset) Expected End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
sLAEndDate	(DateTimeOffset) SLA End Date.
sourceRequestId	(Guid) Source Request Id.
triggerStateId	(Guid) Trigger State Id.
workOrderMaintenancePlans	(List of ApiWorkOrderWorkOrderMaintenancePlansResource) Work Order Maintenance Plans. See ApiWorkOrderWorkOrderMaintenancePlansResource.
workOrderTasks	(List of ApiWorkOrderWorkOrderTasksResource) Work Order Tasks. See ApiWorkOrderWorkOrderTasksResource.
operatingState	(string) Operating State.
preventiveMaintenanceEventId	(Guid) It is used when the WO is created by preventive.
expectedDurationSeconds	(int) Expected Duration Seconds.
actualDurationSeconds	(int) Actual Duration Seconds.
templateParameters	(string) Template Parameters.
notificationResponsibleId	(Guid) Notification Responsible Id.
notificationWorkshopId	(Guid) Notification Workshop Id.
assignedToIds	(string) Assigned To Ids.
previousStateId	(Guid) Previous State Id.
reportLang	(string) It should be removed affter fixing report lang.
exchangeRateDate	(DateTime) Exchange Rate Date.
workOrderNotes	(List of ApiWorkOrderWorkOrderNotesResource) Work Order Notes. See ApiWorkOrderWorkOrderNotesResource.
supplier	(string) Supplier.
customer	(string) Customer.
sourceWorkOrder	(string) Source Work Order.
applyDefaults	(bool) Apply Defaults.
sourceRequestAssetTypeId	(Guid) Source Request Asset Type Id.
isAssetLocked	(bool) Is Asset Locked.

ApiWorkOrderWorkOrderMaintenancePlansResource

The following elements are required:

maintenancePlan	(string) Maintenance Plan.
maintenancePlanType	(string) Maintenance Plan Type.

The following elements are optional:

remarks	(string) Remarks.
workOrderPlanTasks	(List of ApiWorkOrderWorkOrderMaintenancePlansWorkOrderPlanTasksResource) Work Order Plan Tasks. See ApiWorkOrderWorkOrderMaintenancePlansWorkOrderPlanTasksResource.
workshop	(string) Workshop.

ApiWorkOrderWorkOrderMaintenancePlansWorkOrderPlanTasksResource

The following elements are required:

task	(string) Task.
duration	(TimeSpan) Duration.

The following elements are optional:

workOrderPlanTaskKey	(Guid) Work Order Plan Task.
description	(string) Description.
predictedDate	(DateTime) Predicted Date.
timeUnit	(string) Time Unit.
remarks	(string) Remarks.
workshop	(string) Workshop.
verification	(string) Verification.

ApiWorkOrderWorkOrderNotesResource

The following elements are required:

user	(string) User.
message	(string) Message.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.

The following elements are optional:

date	(DateTimeOffset) Date.

ApiWorkOrderWorkOrderTasksResource

The following elements are required:

task	(string) Task.

The following elements are optional:

predictedDate	(DateTime) Predicted Date.
duration	(TimeSpan) Duration.
timeUnit	(string) Time Unit.
remarks	(string) Remarks.
workshop	(string) Workshop.
verification	(string) Verification.

ChangeSchemaEntityStateReturnResource

The following elements are required:

allowAssignments	(bool) Allow Assignments.
allowChangeOperatingState	(bool) Allow Change Operating State.
allowChangeTransitions	(bool) Allow Change Transitions.
allowCostReport	(bool) Allow Cost Report.
allowDownTime	(bool) Allow Down Time.
allowWorkReport	(bool) Allow Work Report.
hasPendingDownTime	(bool) Has Pending Down Time.

ChangeStateTasksContext

The following elements are optional:

batchProcessId	(Guid) Batch Process Id.
notifyOnEnd	(bool) Notify On End.
userId	(Guid) User Id.
userCulture	(string) User Culture.
sourceContext	(string) Source Context.
duplexPrinting	(bool) Duplex Printing.
reportTemplate	(string) Report Template.

CostsSummary

The following elements are optional:

value

(decimal) Value.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

OnlyPrintTask

The following elements are optional:

workOrderKey	(string) Work Order Key.
taskId	(string) Task Id.
errorMessage	(string) Error Message.
reportTemplate	(string) Report Template.
duplexPrinting	(bool) Duplex Printing.
maintenanceTaskId	(string) Maintenance Task Id.
workOrderId	(Guid) Work Order Id.

StateSLA

The following elements are required:

stateId	(Guid) State Id.
dateTransition	(DateTimeOffset) Date Transition.
isChanged	(bool) Is Changed.

SubscriptionAssetType

The following elements are optional:

assetTypeId	(int) Asset Type Id.
assetTypeDescription	(string) Asset Type Description.

WorkOrderAssignedToEmployeeResource

The following elements are required:

workOrderKey	(string) Work Order.
description	(string) Description.
assetType	(enum AssetType) Type. See AssetType.
date	(DateTimeOffset) Date.
expectedDate	(DateTimeOffset) Expected Date.
maintenancePlan	(string) Maintenance Plan.
schemaEntityState	(string) State.
task	(string) Task.
workOrderType	(string) WO Type.
duration	(TimeSpan) Duration.
maintenancePlanType	(string) Maintenance Plan Type.
applyDownTimeChildren	(bool) Apply down time to children.
task	(string) Task.
message	(string) Message.
user	(string) User.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.
company	(string) Company.

The following elements are optional:

equipment	(string) Equipment.
location	(string) Location.
maintenanceRoute	(string) Route.
tool	(string) Tool.
expectedDuration	(TimeSpan) Expected Duration.
expectedEndDate	(DateTimeOffset) Expected End Date.
priorityLevel	(string) Priority Level.
remarks	(string) Remarks.
workOrderMaintenancePlans	(string) Work Order Maintenance Plans.
workOrderPlanTasks	(string) Work Order Plan Tasks.
workshop	(string) Workshop.
predictedDate	(DateTime) Predicted Date.
remarks	(string) Remarks.
timeUnit	(string) Time Unit.
workshop	(string) Workshop.
operatingState	(string) Operating State.
responsible	(string) Person In Charge.
duration	(TimeSpan) Duration.
predictedDate	(DateTime) Predicted Date.
remarks	(string) Remarks.
timeUnit	(string) Time Unit.
verification	(string) Verification.
verification	(string) Verification.
workOrderTasks	(string) Work Order Tasks.
customer	(string) Customer.
supplier	(string) Supplier.
date	(DateTimeOffset) Date.
workOrderNotes	(string) Work Order Notes.

WorkOrderAssignmentsTask

The following elements are required:

workOrder

(string) Work Order.

The following elements are optional:

print	(bool) Print.
taskId	(string) Task Id.
errorMessage	(string) Error Message.
workOrderId	(Guid) Work Order Id.
company	(string) Company.
isLocked	(bool) Is Locked.
value	(string) Value.
fromTbx	(bool) From Tbx.

WorkOrderCanceledClosedByEmployeeResource

The following elements are required:

workOrderKey

(string) Work Order.

WorkOrderChangeStateTask

The following elements are required:

workOrderKey	(string) Work Order Key.
newStateKey	(string) New State Key.

The following elements are optional:

print	(bool) Print.
taskId	(string) Task Id.
errorMessage	(string) Error Message.
maintenanceTaskId	(string) Maintenance Task Id.
reportTemplate	(string) Report Template.
duplexPrinting	(bool) Duplex Printing.
workOrderId	(Guid) Work Order Id.

WorkOrderFilterResource

The following elements are required:

workOrderKey	(string) Work Order.
description	(string) Description.
assetType	(enum AssetType) Type. See AssetType.
date	(DateTimeOffset) Date.
expectedDate	(DateTimeOffset) Expected Date.
maintenancePlan	(string) Maintenance Plan.
schemaEntityState	(string) State.
task	(string) Task.
workOrderType	(string) WO Type.
duration	(TimeSpan) Duration.
maintenancePlanType	(string) Maintenance Plan Type.
applyDownTimeChildren	(bool) Apply down time to children.
task	(string) Task.

The following elements are optional:

equipment	(string) Equipment.
location	(string) Location.
maintenanceRoute	(string) Route.
tool	(string) Tool.
expectedDuration	(TimeSpan) Expected Duration.
expectedEndDate	(DateTimeOffset) Expected End Date.
priorityLevel	(string) Priority Level.
remarks	(string) Remarks.
workOrderMaintenancePlans	(string) Work Order Maintenance Plans.
workOrderPlanTasks	(string) Work Order Plan Tasks.
workshop	(string) Workshop.
predictedDate	(DateTime) Predicted Date.
remarks	(string) Remarks.
timeUnit	(string) Time Unit.
workshop	(string) Workshop.
operatingState	(string) Operating State.
responsible	(string) Person In Charge.
duration	(TimeSpan) Duration.
predictedDate	(DateTime) Predicted Date.
remarks	(string) Remarks.
timeUnit	(string) Time Unit.
verification	(string) Verification.
verification	(string) Verification.
workOrderTasks	(string) Work Order Tasks.
dateTransition	(DateTimeOffset) Date Transition.

WorkOrderInfoResource

The following elements are required:

assetType	(enum AssetType) Type. See AssetType.
company	(string) Company.
date	(DateTimeOffset) Date.
description	(string) Description.
expectedDate	(DateTimeOffset) Expected Date.
schemaEntityState	(string) State.
workOrderKey	(string) Work Order.
maintenancePlan	(string) Maintenance Plan.
task	(string) Task.
task	(string) Task.
workOrderType	(string) WO Type.
applyDownTimeChildren	(bool) Apply down time to children.

The following elements are optional:

autoOpenWO	(bool) Auto Open WO.
location	(string) Location.
equipment	(string) Equipment.
tool	(string) Tool.
maintenanceRoute	(string) Route.
remarks	(string) Remarks.
workOrderMaintenancePlans	(string) Work Order Maintenance Plans.
workOrderPlanTasks	(string) Work Order Plan Tasks.
workOrderTasks	(string) Work Order Tasks.
priorityLevel	(string) Priority Level.
workshop	(string) Workshop.
operatingState	(string) Operating State.
customer	(string) Customer.
responsible	(string) Person In Charge.
supplier	(string) Supplier.

WorkOrderMaintenancePlanResource

The following elements are required:

maintenancePlan	(string) Maintenance Plan.
maintenancePlanType	(string) Maintenance Plan Type.

The following elements are optional:

remarks	(string) Remarks.
workOrderPlanTasks	(List of WorkOrderMaintenancePlanTaskResource) Work Order Plan Tasks. See WorkOrderMaintenancePlanTaskResource.
workshop	(string) Workshop.

WorkOrderMaintenancePlanTaskResource

The following elements are required:

task	(string) Task.
duration	(TimeSpan) Duration.

The following elements are optional:

workOrderPlanTaskKey	(Guid) Work Order Plan Task.
description	(string) Description.
predictedDate	(DateTime) Predicted Date.
timeUnit	(string) Time Unit.
remarks	(string) Remarks.
workshop	(string) Workshop.
verification	(string) Verification.

WorkOrderNoteResource

The following elements are required:

user	(string) User.
message	(string) Message.
visibleTo	(enum VisibleTo) Visible To. See VisibleTo.

The following elements are optional:

date	(DateTimeOffset) Date.

WorkOrderResource

The following elements are required:

exchangeRate	(decimal) Exchange Rate.
workOrderKey	(string) Work Order.
description	(string) Description.
date	(DateTimeOffset) Date.
workOrderType	(string) WO Type.
assetType	(enum AssetType) Type. See AssetType.
schemaEntityState	(string) State.
expectedDate	(DateTimeOffset) Expected Date.
company	(string) Company.
allowWorkReport	(bool) Allow Work Report.
allowCostReport	(bool) Allow Cost Report.
allowAssignments	(bool) Allow Assignments.
allowChangeTransitions	(bool) Allow Change Transitions.
isDownOperatingState	(bool) Is Down Operating State.
applyDownTimeChildren	(bool) Apply down time to children.
allowChangeOperatingState	(bool) Allow Change Operating State.
allowDownTime	(bool) Allow Down Time.
reportDownTime	(bool) Indicates to report down time.
closeDowntime	(bool) Close Downtime.
assetHaveChildrens	(bool) Asset Have Children.
hasPendingDownTime	(bool) Has Pending Down Time.
newStateId	(Guid) New State Id.
subscriptionAssetTypeId	(int) Type.
fromApi	(bool) From Api.
expectedCost	(MoneyResource) Expected Cost. See MoneyResource .
actualCost	(MoneyResource) Actual Cost. See MoneyResource .
currency	(string) Currency.

The following elements are optional:

equipment	(string) Equipment.
tool	(string) Tool.
location	(string) Location.
maintenanceRoute	(string) Route.
priorityLevel	(string) Priority Level.
remarks	(string) Remarks.
equipmentUnderWarranty	(bool) Equipment Under Warranty.
locationShutdown	(string) Location Shutdown.
equipmentShutdown	(string) Equipment Shutdown.
isPrinted	(bool) Is Printed.
autoOpenWO	(bool) Auto Open WO.
processReturns	(bool) Process Returns.
expectedDuration	(TimeSpan) Expected Duration.
actualDuration	(TimeSpan) Actual Duration.
parentLocation	(string) Parent Location.
responsible	(string) Person In Charge.
workshop	(string) Workshop.
currentStateId	(Guid) Current State Id.
expectedEndDate	(DateTimeOffset) Expected End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
sLAEndDate	(DateTimeOffset) SLA End Date.
sourceRequestId	(Guid) Source Request Id.
triggerStateId	(Guid) Trigger State Id.
workOrderMaintenancePlans	(List of WorkOrderMaintenancePlanResource) Work Order Maintenance Plans. See WorkOrderMaintenancePlanResource.
workOrderTasks	(List of WorkOrderTaskResource) Work Order Tasks. See WorkOrderTaskResource.
operatingState	(string) Operating State.
preventiveMaintenanceEventId	(Guid) It is used when the WO is created by preventive.
expectedDurationSeconds	(int) Expected Duration Seconds.
actualDurationSeconds	(int) Actual Duration Seconds.
templateParameters	(string) Template Parameters.
notificationResponsibleId	(Guid) Notification Responsible Id.
notificationWorkshopId	(Guid) Notification Workshop Id.
assignedToIds	(string) Assigned To Ids.
previousStateId	(Guid) Previous State Id.
reportLang	(string) It should be removed affter fixing report lang.
exchangeRateDate	(DateTime) Exchange Rate Date.
workOrderNotes	(List of WorkOrderNoteResource) Work Order Notes. See WorkOrderNoteResource.
supplier	(string) Supplier.
customer	(string) Customer.
sourceWorkOrder	(string) Source Work Order.
applyDefaults	(bool) Apply Defaults.
sourceRequestAssetTypeId	(Guid) Source Request Asset Type Id.
isAssetLocked	(bool) Is Asset Locked.

WorkOrderResourceResource

The following elements are required:

company	(string) Company.
date	(DateTimeOffset) Date.
description	(string) Description.
expectedDate	(DateTimeOffset) Expected Date.
schemaEntityState	(string) State.
workOrderKey	(string) Work Order.
workOrderType	(string) WO Type.
allowWorkReport	(bool) Allow Work Report.
allowCostReport	(bool) Allow Cost Report.
assetType	(enum AssetType) Type. See AssetType.
allowChangeTransitions	(bool) Allow Change Transitions.
allowChangeOperatingState	(bool) Allow Change Operating State.
applyDownTimeChildren	(bool) Apply down time to children.
isDownOperatingState	(bool) Is Down Operating State.
allowAssignments	(bool) Allow Assignments.
allowDownTime	(bool) Allow Down Time.
assetHaveChildrens	(bool) Asset Have Children.
hasPendingDownTime	(bool) Has Pending Down Time.
subscriptionAssetTypeId	(int) Type.
actualCost	(MoneyResource) Actual Cost. See MoneyResource .
expectedCost	(MoneyResource) Expected Cost. See MoneyResource .

The following elements are optional:

actualDuration	(TimeSpan) Actual Duration.
autoOpenWO	(bool) Auto Open WO.
currentStateId	(Guid) Current State Id.
equipment	(string) Equipment.
equipmentShutdown	(string) Equipment Shutdown.
equipmentUnderWarranty	(bool) Equipment Under Warranty.
expectedDuration	(TimeSpan) Expected Duration.
expectedEndDate	(DateTimeOffset) Expected End Date.
isPrinted	(bool) Is Printed.
location	(string) Location.
locationShutdown	(string) Location Shutdown.
parentLocation	(string) Parent Location.
priorityLevel	(string) Priority Level.
processReturns	(bool) Process Returns.
remarks	(string) Remarks.
responsible	(string) Person In Charge.
sLAEndDate	(DateTimeOffset) SLA End Date.
sLAStartDate	(DateTimeOffset) SLA Start Date.
sourceRequestId	(Guid) Source Request Id.
triggerStateId	(Guid) Trigger State Id.
workOrderMaintenancePlans	(List of WorkOrderResourceWorkOrderMaintenancePlansResource) Work Order Maintenance Plans. See WorkOrderResourceWorkOrderMaintenancePlansResource.
workshop	(string) Workshop.
workOrderTasks	(List of WorkOrderResourceWorkOrderTasksResource) Work Order Tasks. See WorkOrderResourceWorkOrderTasksResource.
maintenanceRoute	(string) Route.
tool	(string) Tool.
operatingState	(string) Operating State.
preventiveMaintenanceEventId	(Guid) It is used when the WO is created by preventive.
expectedDurationSeconds	(int) Expected Duration Seconds.
reportLang	(string) It should be removed affter fixing report lang.
workOrderNotes	(List of WorkOrderResourceWorkOrderNotesResource) Work Order Notes. See WorkOrderResourceWorkOrderNotesResource.
customer	(string) Customer.
supplier	(string) Supplier.
sourceWorkOrder	(string) Source Work Order.
sourceRequestAssetTypeId	(Guid) Source Request Asset Type Id.
isAssetLocked	(bool) Is Asset Locked.

WorkOrderResourceWorkOrderMaintenancePlansResource

The following elements are required:

maintenancePlan	(string) Maintenance Plan.
maintenancePlanType	(string) Maintenance Plan Type.

The following elements are optional:

remarks	(string) Remarks.
workshop	(string) Workshop.

WorkOrderResourceWorkOrderNotesResource

The following elements are required:

message	(string) Message.
user	(string) User.

The following elements are optional:

date	(DateTimeOffset) Date.

WorkOrderResourceWorkOrderTasksResource

The following elements are required:

task	(string) Task.

The following elements are optional:

duration	(TimeSpan) Duration.
predictedDate	(DateTime) Predicted Date.
remarks	(string) Remarks.
timeUnit	(string) Time Unit.
verification	(string) Verification.
workshop	(string) Workshop.

WorkordersAttachementsAsset

The following elements are optional:

attachementId	(Guid) Attachement Id.
name	(string) Name.
nameAsset	(string) Name Asset.
size	(decimal) Size.
mediaType	(string) Media Type.
workOrderId	(Guid) Work Order Id.
workOrderKey	(string) Work Order Key.
path	(string) Path.
modifiedOn	(DateTimeOffset) Modified On.

WorkOrderStateInfo

The following elements are required:

workOrderKey	(string) Work Order Key.
newStateKey	(string) New State Key.
reason	(string) Reason.

The following elements are optional:

stateChangeDate

(DateTimeOffset) State Change Date.

WorkOrdersToCloseResource

The following elements are required:

dateTransition	(DateTimeOffset) Date Transition.
workOrderKey	(string) Work Order Key.
schemaEntityStateId	(Guid) Schema Entity State Id.

The following elements are optional:

id	(Guid) Id.

WorkOrderTaskResource

The following elements are required:

task	(string) Task.

The following elements are optional:

predictedDate	(DateTime) Predicted Date.
duration	(TimeSpan) Duration.
timeUnit	(string) Time Unit.
remarks	(string) Remarks.
workshop	(string) Workshop.
verification	(string) Verification.

WorkOrderUnassignmentsTask

The following elements are required:

workOrder

(string) Work Order.

The following elements are optional:

taskId	(string) Task Id.
errorMessage	(string) Error Message.
workOrderId	(Guid) Work Order Id.
company	(string) Company.
isLocked	(bool) Is Locked.
value	(string) Value.
fromTbx	(bool) From Tbx.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.