WorkOrderSearchRequest
Version: v4.4.0
Supporting model
A request/response or nested model — not a stored DynamoDB entity.
Overview
Model for work order search request parameters
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
page_size | int | ❌ | 15 | — |
page_index | int | ❌ | 0 | — |
free_text_query | str | ❌ | — | — |
work_order_display_id | str | ❌ | — | — |
only_show_without_invoice | bool | ❌ | — | — |
only_show_not_completed | bool | ❌ | — | — |
hide_cancelled | bool | ❌ | — | — |
reference | str | ❌ | — | — |
due_date | str | ❌ | — | — |
status | List[str] | ❌ | — | — |
department | List[str] | ❌ | — | — |
location | List[str] | ❌ | — | — |
user_id | List[str] | ❌ | — | — |
assignee | List[str] | ❌ | — | — |
tag_id | str | ❌ | — | — |
item_status | List[str] | ❌ | — | — |
contact | List[str] | ❌ | — | — |
sales_channel | List[str] | ❌ | — | — |
start_date | str | ❌ | — | — |
end_date | str | ❌ | — | — |
sales_person | List[str] | ❌ | — | — |
time_zone | str | ❌ | Pacific/Auckland | — |
sort_by | WorkOrderSearchSortByEnum (DUE_DATE, WORK_ORDER_NUMBER, STATUS) | ❌ | — | WorkOrderSearchSortBy |
APIs / Triggers
| Trigger | Endpoint / Source | Detail | Handler |
|---|---|---|---|
| API | POST /newworkOrder/search | — | src/work_order_search.py |
Change history
v4.4.0 · 2026-06-08 · Cian (shared account) · 103822bbb
Add hide_cancelled to work order search
- Added optional field
hide_cancelled.
v4.3.0 · 2026-05-02 · Cian (shared account) · 005741347
Add work order display ID search filtering
- Added optional field
work_order_display_id.
v4.2.0 · 2025-07-29 · Olaniyi Ajayi · 1200b9f37
fx assignee filter
- Added optional field
assignee.
v4.1.0 · 2025-07-24 · Olaniyi Ajayi · 15615abd5
added location filter
- Added optional field
location.
v4.0.0 · 2025-07-24 · Olaniyi Ajayi · 7cb1bf5f7
rm by user function
- Removed field
assignee(breaking). - Added optional field
tag_id. - Added optional field
user_id.
v3.2.0 · 2025-07-22 · Olaniyi Ajayi · fb92fb246
sort by status
- Field
sort_byenum valueSTATUSadded.
v3.1.0 · 2025-07-22 · Olaniyi Ajayi · 28257f990
get my tasks
- Field
sort_byenum valueWORK_ORDER_NUMBERadded.
v3.0.0 · 2025-07-21 · Olaniyi Ajayi · cdb1432d5
get workorder by display id
- Field
sort_byenum valueSTATUSremoved (breaking).
v2.2.0 · 2025-07-21 · Olaniyi Ajayi · 25260fc62
update sortby
- Added optional field
sort_by.
v2.1.0 · 2025-07-13 · Cian (shared account) · 03696f6cb
fx
- Added optional field
time_zone.
v2.0.0 · 2025-07-12 · Cian (shared account) · 3713e7962
fx
- Removed field
sales_person_id(breaking). - Removed field
stage(breaking). - Added optional field
assignee. - Added optional field
department. - Added optional field
item_status. - Added optional field
sales_channel.
v1.0.0 · 2025-07-11 · Cian (shared account) · abd0d451a
fx
- Initial version.
Generated from
dismantly-backend/Microservices/WorkOrder/dependencies/models.py. Do not edit by hand.