WM API Changes

Warning

Some API changes are not backward compatible

Breaking Changes

Path	Description
GET /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForAsset	Condition monitoring redesign
GET /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForSite	Condition monitoring redesign
GET /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskStandardTask	Condition monitoring redesign

Changelog

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/WorkOrders/Lookups/LookupWorkOrderAlarm
- GET    /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}/Download
- GET    /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}
- DELETE /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}
- PATCH  /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}
- GET    /Modules/WM/WorkOrders/Tasks/{id}/FileAttachments
- GET    /Modules/WM/WorkOrders/Tasks/FileAttachments
- POST   /Modules/WM/WorkOrders/Tasks/FileAttachments/Upload
- PUT    /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}/Upload
- GET    /Modules/WM/WorkOrders/Tasks/FileAttachments/Batch/{ids}
- GET    /Modules/WM/WorkOrders/Tasks/FileAttachments/{id}/ContentHistory
- POST   /Modules/WM/WorkOrders/Tasks/FileAttachments/Upload/Batch
- DELETE /Modules/WM/WorkOrders/Tasks/FileAttachments/Batch
- PATCH  /Modules/WM/WorkOrders/Tasks/FileAttachments/Batch

--------------------------------------------------------------------------
--                            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/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/DueTasks/Suppressors/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/DueTasks/Suppressors/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/ProposedWorkOrders/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/ProposedWorkOrders/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/ProposedWorkOrders/Tasks/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/ProposedWorkOrders/Tasks/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: Backward compatible
- GET    /Modules/WM/WorkOrders
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- 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: Backward compatible
- POST   /Modules/WM/WorkOrders/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Attributes/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Attributes/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/CompleteAllTasksLogs/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/CompleteAllTasksLogs/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/DowntimeLosses/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/DowntimeLosses/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/FileAttachments/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/FileAttachments/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Meters/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Meters/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Movements/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Movements/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/StatusChangeHistory/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/StatusChangeHistory/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForAsset
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.isReadingRequired (boolean)
          Missing property: items[n].properties.monitoringPointId (integer)
          Missing property: items[n].properties.monitoringPointCode (string)
          Missing property: items[n].properties.monitoringPointDescription (string)
- GET    /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskAssetTaskForSite
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.isReadingRequired (boolean)
          Missing property: items[n].properties.monitoringPointId (integer)
          Missing property: items[n].properties.monitoringPointCode (string)
          Missing property: items[n].properties.monitoringPointDescription (string)
- GET    /Modules/WM/WorkOrders/Tasks/Lookups/LookupWorkOrderTaskStandardTask
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.isReadingRequired (boolean)
- GET    /Modules/WM/WorkOrders/Tasks/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Movements/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Movements/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceResource
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Lookups/LookupWorkOrderTaskResourceWorkOrderTask
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Durations/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Durations/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Movements/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Resources/Movements/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Spares/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Spares/Lookups/LookupWorkOrderTaskSpareWorkOrderTask
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Spares/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Spares/Movements/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/Spares/Movements/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/SubTasks/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/SubTasks/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/SubTasks/Movements/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkOrders/Tasks/SubTasks/Movements/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkRequests/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/WM/WorkRequests/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------