WorkOrder — Data Models
info
Auto-generated from dismantly-backend/Microservices/WorkOrder/dependencies/models.py. Do not edit by hand.
Interaction map
How the APIs and events in this service read and write its objects, and how changes flow downstream.
tip
Click an object box (e.g. the CONTACT cylinder) to open its page, or a handler box to view its source on GitHub. Drag to pan, scroll to zoom, or use the Fullscreen button.
Stored Objects (Entities)
| Object | Discriminator | Version |
|---|---|---|
| Contact | CONTACT | v2.0.0 |
| Departments | — | v1.0.0 |
| TablePreferencesItem | TABLE_CONFIG | v1.0.0 |
| WorkOrder | — | v2.1.0 |
| WorkOrderColumnPreferencesObject | WORK_ORDER_COLUMN_PREFERENCES | v2.0.0 |
| WorkOrderFlatViewColumnPreferencesObject | WORK_ORDER_FLAT_VIEW_COLUMN_PREFERENCES | v1.0.0 |
| WorkOrderRowDetailsColumnPreferencesObject | WORK_ORDER_ROW_DETAILS_COLUMN_PREFERENCES | v1.0.0 |
Supporting Models
API Surface
Every endpoint and event in this service, with the model(s) it uses.
| Trigger | Endpoint / Source | Handler | Model(s) |
|---|---|---|---|
| API | POST /newworkOrder/department | src/department/work_order_department_create.py | DepartmentPost, Departments, DepartmentsPost |
| API | DELETE /newworkOrder/department | src/department/work_order_department_delete.py | DepartmentDelete |
| API | GET /newworkOrder/department | src/department/work_order_department_get.py | — |
| API | PUT /newworkOrder/department | src/department/work_order_department_update.py | DepartmentUpdate |
| Event | EventBridge | src/handle/work_order_handle_department_deleted.py | HandleDepartmentDelete, StatusEnum |
| Event | EventBridge | src/handle/work_order_handle_department_updated.py | DepartmentUpdate, StatusEnum |
| Event | EventBridge | src/handle/work_order_handle_sales_channel_webhook.py | ItemTypeEnum, LineItem, SalesChannelLineItem, StatusEnum, WorkOrder, WorkOrderHandleSalesChannel |
| Event | EventBridge | src/handle/work_order_handle_status_notification.py | — |
| API | GET /newworkOrder/history | src/history/work_order_history_get.py | — |
| Stream | DynamoDB stream | src/history/work_order_history_process.py | — |
| API | POST /newworkOrder/pinnacle | src/pinnacle/work_order_handle_create.py | Address, Contact, LineItem, StatusEnum, WorkOrder |
| Event | EventBridge | src/pinnacle/work_order_handle_delete.py | — |
| API | PUT /newworkOrder/updateBlockedStatus | src/work_order_block_status_update.py | StatusEnum, WorkOrderBlockLineItem |
| API | PUT /newworkOrder/updateCancelStatus | src/work_order_cancellation_status_update.py | StatusEnum, WorkOrderCancel |
| API | POST /newworkOrder/ | src/work_order_create.py | StatusEnum, WorkOrder, WorkOrderCreate |
| API | DELETE /newworkOrder/ | src/work_order_delete.py | WorkOrderID |
| API | GET /newworkOrder/ | src/work_order_get.py | WorkOrderID |
| API | GET /newworkOrder/columnPreferences | src/work_order_get_column_preferences.py | WorkOrderColumnPreferences, WorkOrderLegacyMainColumnPreferences, WorkOrderSelectedView |
| API | GET /newworkOrder/flatViewColumnPreferences | src/work_order_get_flat_view_column_preferences.py | — |
| API | GET /newworkOrder/rowDetailsColumnPreferences | src/work_order_get_row_details_column_preferences.py | — |
| API | GET /newworkOrder/tablePreferences | src/work_order_get_table_preferences.py | TableKeyEnum |
| API | PUT /newworkOrder/lineItemDepartmentUpdate | src/work_order_line_item_department_update.py | StatusEnum, WorkOrderLineItemDepartmentUpdate |
| API | GET /newworkOrder/lineItemGet | src/work_order_line_item_get.py | WorkOrderLineItemGet |
| API | PUT /newworkOrder/lineItemLocationUpdate | src/work_order_line_item_location_update.py | WorkOrderLineItemLocationUpdate |
| API | PUT /newworkOrder/lineItemUpdateStatus | src/work_order_line_item_status_update.py | StatusEnum, WorkOrderLineItemStatusUpdate |
| API | PUT /newworkOrder/lineItemUserUpdate | src/work_order_line_item_user_update.py | WorkOrderLineItemUserUpdate |
| Stream | DynamoDB stream | src/work_order_opensearch_sync.py | — |
| API | POST /newworkOrder/columnPreferences | src/work_order_post_column_preferences.py | WorkOrderColumnPreferences, WorkOrderColumnPreferencesObject |
| API | POST /newworkOrder/flatViewColumnPreferences | src/work_order_post_flat_view_column_preferences.py | WorkOrderFlatViewColumnPreferences, WorkOrderFlatViewColumnPreferencesObject |
| API | POST /newworkOrder/rowDetailsColumnPreferences | src/work_order_post_row_details_column_preferences.py | WorkOrderRowDetailsColumnPreferences, WorkOrderRowDetailsColumnPreferencesObject |
| API | POST /newworkOrder/tablePreferences | src/work_order_post_table_preferences.py | TableKeyEnum, TablePreferencesItem, TablePreferencesPayload |
| API | PUT /newworkOrder/lineItemReplace | src/work_order_replace_line_item.py | LineItem, LineItemCreate, StatusEnum, WorkOrderReplaceLineItem |
| API | POST /newworkOrder/search | src/work_order_search.py | WorkOrderSearchRequest, WorkOrderSearchSortByEnum |
| API | POST /newworkOrder/search/filters | src/work_order_search_filters.py | FilterCountMode, FilterDropdownRequest, FilterField, FilterParameter |
| API | POST /newworkOrder/search/individualParts | src/work_order_search_parts.py | IndividualPartsSearchRequest, IndividualPartsSearchSortByEnum |
| Event | EventBridge | src/work_order_self_heal.py | — |
| API | PUT /newworkOrder/updateStatus | src/work_order_status_update.py | Department, LineItem, StatusEnum, WorkOrderStatusUpdate |
| API | PUT /newworkOrder/ | src/work_order_update.py | LineItem, StatusEnum, WorkOrderUpdate |
| Event | EventBridge | src/work_order_update_invoice_link.py | WorkOrderUpdateInvoiceLink |