Valuekeep Developers - Web API Reference

Work | WO Managements

Overview


URL api/{tenantKey}/{orgKey}/maintenance/wOManagements
Methods Supported GET, POST

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET WO Managements

Returns the list of entity records that can be processed by the 'WorkOrders' service.

The following elements are required:

pageIndex (int) The index of the page of the list that should be returned.
pageSize (int) The number of page elements that should be returned (max. is 1000).
schemaEntityState (string) State.
operation (WOManagementOperation) Print.

The following elements are optional:

fWorkshop (string) Workshop This is a query string parameter.
company (string) Company This is a query string parameter.
expectedDate (DateTimeOffset?) Expected Date This is a query string parameter.
workOrderState (string) Work Order State This is a query string parameter.
location (string) Location This is a query string parameter.
equipment (string) Equipment This is a query string parameter.
tool (string) Tool This is a query string parameter.
maintenanceRoute (string) Route This is a query string parameter.
workshop (string) Workshop This is a query string parameter.
asset (string) Asset This is a query string parameter.
startDate (DateTime?) Start Date This is a query string parameter.
endDate (DateTime?) End Date This is a query string parameter.
newSchemaEntityState (string) New State This is a query string parameter.
duplexPrinting (bool?) Duplex Printing This is a query string parameter.
showInlineAlertMessage (bool?) Show Inline Alert Message This is a query string parameter.
fWorkOrderType (string) Work Order Type This is a query string parameter.
assignedTo (string) Assigned To This is a query string parameter.
fAsset (string) Asset This is a query string parameter.
employee (string) Employee This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See WorkOrderManagementLine.

Response status codes:

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

Resource URL:

GET /maintenance/wOManagements/{pageIndex}/{pageSize}?fWorkshop={fWorkshop}&company={company}&expectedDate={expectedDate}&workOrderState={workOrderState}&location={location}&equipment={equipment}&tool={tool}&maintenanceRoute={maintenanceRoute}&workshop={workshop}&asset={asset}&startDate={startDate}&endDate={endDate}&newSchemaEntityState={newSchemaEntityState}&duplexPrinting={duplexPrinting}&showInlineAlertMessage={showInlineAlertMessage}&fWorkOrderType={fWorkOrderType}&assignedTo={assignedTo}&fAsset={fAsset}&employee={employee}

POST Operations

POST WO Managements

Instructs the 'WorkOrders' service to process the specified entity records.

The following elements are required:

list (WorkOrderManagementLine) List of the entity records that should be processed.
See WorkOrderManagementLine.
companyKey (string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

POST /maintenance/wOManagements/{companyKey}

Resources


WorkOrderManagement

The following elements are required:

selectedCount (int) Selected Count.
schemaEntityState (string) State.
operation (enum WOManagementOperation) Print.
See WOManagementOperation.

The following elements are optional:

fWorkshop (string) Workshop.
company (string) Company.
expectedDate (DateTimeOffset) Expected Date.
workOrderState (string) Work Order State.
location (string) Location.
equipment (string) Equipment.
tool (string) Tool.
maintenanceRoute (string) Route.
workshop (string) Workshop.
asset (string) Asset.
startDate (DateTime) Start Date.
endDate (DateTime) End Date.
newSchemaEntityState (string) New State.
duplexPrinting (bool) Duplex Printing.
showInlineAlertMessage (bool) Show Inline Alert Message.
fWorkOrderType (string) Work Order Type.
assignedTo (string) Assigned To.
fAsset (string) Asset.
employee (string) Employee.


WorkOrderManagementLine

The following elements are required:

selected (bool) Selected.
workOrdersMaintenanceLine (string) Work Orders Maintenance Line.

The following elements are optional:

workOrder (string) Work Order.
description (string) Description.
expectedDate (DateTimeOffset) Expected Date.
workOrderType (string) WO Type.
assetType (string) Asset Type.
asset (string) Asset.
workshop (string) Workshop.
responsible (string) Responsible.
priorityLevel (string) Priority Level.
company (string) Company.