Table of Contents

WM API Changes

Warning

Some API changes are not backward compatible

A more detailed breakdown for the individual changes can be viewed here

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                       On Key WM  API Specification                       
--------------------------------------------------------------------------
--                              What's New                              --
--------------------------------------------------------------------------
- GET    /Modules/WM/ProposedWorkOrders/Batches
- DELETE /Modules/WM/ProposedWorkOrders/Batches/{id}
- DELETE /Modules/WM/ProposedWorkOrders/Batches/Batch
- DELETE /Modules/WM/ProposedWorkOrders/Batches/All
- GET    /Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone1Type
- GET    /Modules/WM/WorkOrders/Lookups/LookupWorkOrderPhone2Type
- GET    /Modules/WM/WorkRequests/{id}
- PATCH  /Modules/WM/WorkRequests/{id}
- GET    /Modules/WM/WorkRequests
- POST   /Modules/WM/WorkRequests
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestAsset
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestChangePermissionTree
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestFailedComponent
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestInsertPermissionTree
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone1Type
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestPhone2Type
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleSection
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestResponsibleStaffMember
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestSite
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestStatus
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderAsset
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderCostCentre
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderFailedComponent
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderGeneralLedger
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrder
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSection
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderSite
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderStaffMember
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTrade
- GET    /Modules/WM/WorkRequests/Lookups/LookupWorkRequestWorkOrderTypeOfWork
- GET    /Modules/WM/WorkRequests/Batch/{ids}
- POST   /Modules/WM/WorkRequests/Batch
- PATCH  /Modules/WM/WorkRequests/Batch
- PATCH  /Modules/WM/WorkRequests/{id}/PermissionTree
- POST   /Modules/WM/WorkRequests/CreateWorkOrder
- POST   /Modules/WM/WorkRequests/LinkWorkOrder
- POST   /Modules/WM/WorkRequests/Status/Batch
- POST   /Modules/WM/WorkRequests/Status
- PATCH  /Modules/WM/WorkRequests/Batch/PermissionTree
- GET    /Modules/WM/WorkRequests/Attributes/{id}
- DELETE /Modules/WM/WorkRequests/Attributes/{id}
- PATCH  /Modules/WM/WorkRequests/Attributes/{id}
- GET    /Modules/WM/WorkRequests/{workRequestId}/Attributes
- GET    /Modules/WM/WorkRequests/Attributes
- POST   /Modules/WM/WorkRequests/Attributes
- GET    /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeAllowedValue
- GET    /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttribute
- GET    /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeChangePermissionTree
- GET    /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeInsertPermissionTree
- GET    /Modules/WM/WorkRequests/Attributes/Lookups/LookupWorkRequestAttributeWorkRequest
- GET    /Modules/WM/WorkRequests/Attributes/Batch/{ids}
- POST   /Modules/WM/WorkRequests/Attributes/Batch
- DELETE /Modules/WM/WorkRequests/Attributes/Batch
- PATCH  /Modules/WM/WorkRequests/Attributes/Batch
- PATCH  /Modules/WM/WorkRequests/Attributes/{id}/Active
- PATCH  /Modules/WM/WorkRequests/Attributes/{id}/PermissionTree
- PATCH  /Modules/WM/WorkRequests/Attributes/Batch/PermissionTree
- PATCH  /Modules/WM/WorkRequests/Attributes/Batch/Active
- GET    /Modules/WM/WorkRequestStatuses/{id}
- DELETE /Modules/WM/WorkRequestStatuses/{id}
- PATCH  /Modules/WM/WorkRequestStatuses/{id}
- GET    /Modules/WM/WorkRequestStatuses
- POST   /Modules/WM/WorkRequestStatuses
- GET    /Modules/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusChangePermissionTree
- GET    /Modules/WM/WorkRequestStatuses/Lookups/LookupWorkRequestStatusInsertPermissionTree
- GET    /Modules/WM/WorkRequestStatuses/Batch/{ids}
- POST   /Modules/WM/WorkRequestStatuses/Batch
- DELETE /Modules/WM/WorkRequestStatuses/Batch
- PATCH  /Modules/WM/WorkRequestStatuses/Batch
- PATCH  /Modules/WM/WorkRequestStatuses/{id}/Active
- PATCH  /Modules/WM/WorkRequestStatuses/{id}/PermissionTree
- PATCH  /Modules/WM/WorkRequestStatuses/Batch/Active
- PATCH  /Modules/WM/WorkRequestStatuses/Batch/PermissionTree
- GET    /Modules/WM/WorkRequests/StatusChangeHistory/{id}
- GET    /Modules/WM/WorkRequests/StatusChangeHistory
- GET    /Modules/WM/WorkRequests/{workRequestId}/StatusChangeHistory
- GET    /Modules/WM/WorkRequests/StatusChangeHistory/Batch/{ids}

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /Modules/WM/DueTasks/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/DueTasks
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/WM/DueTasks/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Broken compatibility
          Missing property: properties.phone (string)
- GET    /Modules/WM/WorkOrders
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.phone (string)
- POST   /Modules/WM/WorkOrders
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Broken compatibility
          Missing property: items[n].properties.phone (string)
- POST   /Modules/WM/WorkOrders/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------