Work Orders
Retrieve and manage work order records.
| Field | Data Type | POST | PATCH |
|---|---|---|---|
| WorkOrderID | String | X | X |
| Description | String | X | X |
| AssetType | String | X | X |
| RequestDate | DateTime | X | X |
| RequestedStartDate | DateTime | X | X |
| RequestedFinishDate | DateTime | X | X |
| ScheduledStartDate | DateTime | X | X |
| ScheduledFinishDate | DateTime | X | X |
| ActualStartDate | DateTime | X | X |
| ActualFinishDate | DateTime | X | X |
| Status | String | X | X |
| State | String | X | X |
| Notes | String | X | X |
| CreatedBy | String | ||
| DateCreated | DateTime | ||
| EditedBy | String | ||
| DateEdited | DateTime | ||
| Boolean | X | X | |
| Warranty | Boolean | X | X |
| ScheduledDownTime | Decimal | X | X |
| ActualDownTime | Decimal | X | X |
| PickList | Boolean | X | X |
| WOPriority | Decimal | X | X |
| ClosedDate | DateTime | X | X |
| AssetID | String | X | X |
| RequestID | String | X | X |
| PMID | String | X | X |
| Priority | String | X | X |
| Type | String | X | X |
| HoldReason | String | X | X |
| ParentWO | String | X | X |
| AssignedTo | String | X | X |
| AssignedBy | String | X | X |
| FailureMode | String | X | X |
| RequestedBy | String | X | X |
| WorkGroupID | String | X | X |
| ProjectID | String | X | X |
| ProjectStageID | String | X | X |
| PDMID | String | X | X |
| Solution | String | X | X |
| ExpenseClass | String | X | X |
| AssetDown | Boolean | X | X |
| AssetDownReason | String | X | X |
Key: WorkOrderID
Required property: WorkOrderID
Endpoints
GET
URL: https://{site}.mvpplant.com/ODataApi/v1/WorkOrders
Description: Retrieve work order records.
POST
URL: https://{site}.mvpplant.com/ODataApi/v1/WorkOrders
Description: Create a work order record.
Body: Send the property values marked in the POST column.
PATCH
URL: https://{site}.mvpplant.com/ODataApi/v1/WorkOrders('workOrderID')
Description: Update an existing work order record.
Body: Send only the property values you want to update from the PATCH column.
OData Query Examples
-
Select specific fields:
https://{site}.mvpplant.com/ODataApi/v1/WorkOrders?$select=WorkOrderID,Description,Status,Priority -
Filter active work orders:
https://{site}.mvpplant.com/ODataApi/v1/WorkOrders?$filter=Status ne 'Completed' -
Sort by requested start date:
https://{site}.mvpplant.com/ODataApi/v1/WorkOrders?$orderby=RequestedStartDate desc -
Return the first 10 records:
https://{site}.mvpplant.com/ODataApi/v1/WorkOrders?$top=10
Notes
CreatedBy,DateCreated,EditedBy, andDateEditedare system-generated fields.- Use
WorkOrderIDas the key field for work order records.