Valuekeep Developers - Web API Reference

Work | Work Order Request

Service to manage entities of type 'WorkOrderRequest'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET WorkOrderRequests (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 WorkOrderRequestResource.

Response status codes:

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

Resource URL:

GET /maintenance/workOrderRequests/odata

GET WorkOrderRequest 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 WorkOrderRequestResource.

Response status codes:

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

Resource URL:

GET /maintenance/workOrderRequests/{id}

GET WorkOrderRequest by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrder (string) Work Order.
request (string) Request.

Response:

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

Response status codes:

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

Resource URL:

GET /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}

GET Request Has Work Order

Indicates whether the request has an associated work order.

The following elements are required:

requestId (Guid) RequestId.

Response:

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

Response status codes:

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

Resource URL:

GET /maintenance/workOrderRequests/requestHasWorkOrder/{requestId}

GET Get Request Follow Up

Custom operation 'GetRequestFollowUp'.

The following elements are required:

requestKey (string) RequestKey.

Response:

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

Response status codes:

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

Resource URL:

GET /maintenance/workOrderRequests/getRequestFollowUp/{requestKey}

POST Operations

POST WorkOrderRequests

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /maintenance/workOrderRequests

POST Get Work Order Requests By Work Order

Custom operation 'GetWorkOrderRequestsByWorkOrder'.

The following elements are required:

workOrderKey (string) WorkOrderKey.

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

Resource URL:

POST /maintenance/workOrderRequests/getWorkOrderRequestsByWorkOrder/{workOrderKey}

POST Get Work Order Requests By Request

Custom operation 'GetWorkOrderRequestsByRequest'.

The following elements are required:

requestKey (string) RequestKey.

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

Resource URL:

POST /maintenance/workOrderRequests/getWorkOrderRequestsByRequest

PUT Operations

PUT Set ApplyDownTimeChildren WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/applyDownTimeChildren

PUT Set CloseDowntime WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/closeDowntime

PUT Set Company WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/company

PUT Set IsActive WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/isActive

PUT Set LinkedWO WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/linkedWO

PUT Set ReportDownTime WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/reportDownTime

PUT Set Request WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/request

PUT Set WorkOrder WorkOrderRequest

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

The following elements are required:

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

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/workOrder

PUT Set Custom Attribute WorkOrderRequest

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

The following elements are required:

companyKey (string) The company key.
workOrder (string) Work Order
request (string) Request
customAttributeName (string) The custom attribute name.
value (ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute.
See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

PUT /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}/{customAttributeName}

DELETE Operations

DELETE WorkOrderRequest by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /maintenance/workOrderRequests/{id}

DELETE WorkOrderRequest by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
workOrder (string) Work Order.
request (string) Request.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /maintenance/workOrderRequests/{companyKey}/{workOrder}/{request}

Resources


ApiWorkOrderRequestResource

The following elements are required:

workOrder (string) Work Order.
request (string) Request.
company (string) Company.
applyDownTimeChildren (bool) Apply Down Time Children.
reportDownTime (bool) Report Down Time.
closeDowntime (bool) Close Downtime.

The following elements are optional:

linkedWO (bool) Linked WO.


RequestFollowUpResource

The following elements are optional:

workOrder (string) Work Order.
workOrderTitle (string) Work Order Title.
workOrderSubTitle (string) Work Order Sub Title.
priorityLevel (string) Priority Level.
priorityLevelTitle (string) Priority Level Title.
priorityLevelSubTitle (string) Priority Level Sub Title.
expectedEndDate (string) Expected End Date.
expectedEndDateTitle (string) Expected End Date Title.
expectedEndDateSubTitle (string) Expected End Date Sub Title.


WorkOrderRequestResource

The following elements are required:

workOrder (string) Work Order.
request (string) Request.
company (string) Company.
applyDownTimeChildren (bool) Apply Down Time Children.
reportDownTime (bool) Report Down Time.
closeDowntime (bool) Close Downtime.

The following elements are optional:

linkedWO (bool) Linked WO.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.