V3_WO_GetByFilter (Get)
- Last UpdatedNov 06, 2025
- 2 minute read
| Get | V3_WO_GetByFilter |
Resource Path:/api/v3/WO/filter
| Name | Description | Data Type |
|---|---|---|
| woId | Optional filter parameter. A work order ID. | string |
| itemId | Optional filter parameter. An item ID. | string |
| newState | Required. A flag that indicates whether a work order's status is New. | boolean |
| readyState | Required. A flag that indicates whether a work order's status is Ready. | boolean |
| runningState | Required. A flag that indicates whether the work order's status is Running. | boolean |
| completeState | Required. A flag that indicates whether the work order's status is Complete. | boolean |
| suspendedState | Required. A flag that indicates whether the work order's status is Suspended. | boolean |
| onHoldState | Required. A flag that indicates whether the work order's status is Onhold. | boolean |
| targetSchedLineId | Optional filter parameter. A value that filters work orders based on their line assignment.
| integer |
| numberOfWorkOrders | Optional. The maximum number of work orders to be returned. The most recently created work orders (that is, those with the highest row_id values) are returned. | integer |
| lastEditHr | Optional filter parameter. This filter applies only to Completed or Canceled work orders. The number of hours prior to the current time during which work orders have been completed or canceled. | integer |
| includeWorkOrdersFromProcess | Required. A flag that indicates whether a work order was created from a process. | boolean |
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
| max_rows | Used to supply the maximum number of rows that will be returned by the get. |
The response body is of type Array[Generated.Models.V3_WO_GetByFilter].
OKTo retrieve all work orders, pass false for the work order status parameters, -1 for targetSchedLineId, true for includeWorkOrdersFromProcess, and null for all other optional filter parameters.