Work | Work Order Type

Service to manage entities of type 'WorkOrderType'.

Overview

URL	api/{tenantKey}/{orgKey}/maintenanceCore/workOrderTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET WorkOrderTypes (odata)
  • GET WorkOrderType by identifier
  • GET WorkOrderType by key
• POST:
  • POST WorkOrderTypes
• PUT:
  • PUT Set Custom Attribute WorkOrderType
  • PUT Set IsActive WorkOrderType
  • PUT Set WorkOrderTypeKey WorkOrderType
  • PUT Set Description WorkOrderType
  • PUT Set IsDefault WorkOrderType
  • PUT Set Remarks WorkOrderType
  • PUT Set DefaultMaintenancePlan WorkOrderType
  • PUT Set PriorityLevel WorkOrderType
  • PUT Set Workshop WorkOrderType
  • PUT Set AssignToTechnicianWhoCreatedWO WorkOrderType
  • PUT Set AssignToWorkOrderResponsible WorkOrderType
  • PUT Set AssignToWorkshopManagers WorkOrderType
  • PUT Set AssignToWorkshopTechnicians WorkOrderType
  • PUT Set SparePartConsumption WorkOrderType
  • PUT Set PartAverageCostPricing WorkOrderType
• DELETE:
  • DELETE WorkOrderType by identifier
  • DELETE WorkOrderType by key

All Resources

This service uses the following resources:

• ApiWorkOrderTypeResource
• WorkOrderTypeResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET WorkOrderTypes (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 WorkOrderTypeResource.

Response status codes:

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

Resource URL:

GET WorkOrderType 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 WorkOrderTypeResource.

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

Returns the entity record that matches the specified key.

The following elements are required:

workOrderTypeKey

(string) Work Order Type.

Response:

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

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST WorkOrderTypes

Creates a new entity record.

The following elements are required:

workOrderTypeResource

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

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

Response status codes:

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

Resource URL:

PUT Operations

PUT Set AssignToTechnicianWhoCreatedWO WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 AssignToWorkOrderResponsible WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 AssignToWorkshopManagers WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 AssignToWorkshopTechnicians WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 DefaultMaintenancePlan WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 Description WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 IsActive WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 IsDefault WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 PartAverageCostPricing WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 PriorityLevel WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 SparePartConsumption WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 WorkOrderTypeKey WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
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 WorkOrderType

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

The following elements are required:

workOrderTypeKey	(string) Work Order Type
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 WorkOrderType 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 WorkOrderType by key

Deletes the entity record that matches the specified key.

The following elements are required:

workOrderTypeKey

(string) Work Order Type.

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

ApiWorkOrderTypeResource

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
description	(string) Description.
assignToTechnicianWhoCreatedWO	(bool) Assign to who created the WO.
assignToWorkOrderResponsible	(bool) Assign to WO Responsible.
assignToWorkshopManagers	(bool) Assign to Workshop Managers.
assignToWorkshopTechnicians	(bool) Assign to Workshop Technicians.

The following elements are optional:

isDefault	(bool) Is Default.
remarks	(string) Remarks.
defaultMaintenancePlan	(string) Maintenance Plan.
priorityLevel	(string) Priority Level.
workshop	(string) Workshop.
sparePartConsumption	(bool) Consumption from spare parts.
partAverageCostPricing	(bool) Use Average Cost Pricing.

WorkOrderTypeResource

The following elements are required:

workOrderTypeKey	(string) Work Order Type.
description	(string) Description.
assignToTechnicianWhoCreatedWO	(bool) Assign to who created the WO.
assignToWorkOrderResponsible	(bool) Assign to WO Responsible.
assignToWorkshopManagers	(bool) Assign to Workshop Managers.
assignToWorkshopTechnicians	(bool) Assign to Workshop Technicians.

The following elements are optional:

isDefault	(bool) Is Default.
remarks	(string) Remarks.
defaultMaintenancePlan	(string) Maintenance Plan. (fk) Allowed value: the natural key of a record of type MaintenancePlan. These records are accessibly through the MaintenancePlans service.
priorityLevel	(string) Priority Level. (fk) Allowed value: the natural key of a record of type PriorityLevel. These records are accessibly through the PriorityLevels service.
workshop	(string) Workshop. (fk) Allowed value: the natural key of a record of type Workshop. These records are accessibly through the Workshops service.
sparePartConsumption	(bool) Consumption from spare parts.
partAverageCostPricing	(bool) Use Average Cost Pricing.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.