Table of Contents

AHM API Changes

Note

API changes are backward compatible

Changelog

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

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                      On Key AHM  API Specification                       
--------------------------------------------------------------------------
--                              What's New                              --
--------------------------------------------------------------------------
- GET    /Modules/AHM/Alarms/Lookups/LookupAlarmAsset
- GET    /Modules/AHM/Alarms/Lookups/LookupAlarmWorkOrder
- POST   /Modules/AHM/Alarms/Batch/{alarmIds}/CreateWorkOrder
- POST   /Modules/AHM/Alarms/{id}/CreateWorkOrder
- GET    /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderSection
- GET    /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderTypeOfWork
- GET    /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderStatus

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /Modules/AHM/Alarms/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- POST   /Modules/AHM/Alarms
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/AHM/Alarms
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Backward compatible
- GET    /Modules/AHM/Alarms/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- POST   /Modules/AHM/Alarms/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/AHM/AlarmTypes/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- POST   /Modules/AHM/AlarmTypes
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/AHM/AlarmTypes/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- POST   /Modules/AHM/AlarmTypes/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- GET    /Modules/AHM/MonitoringPointTriggers/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- POST   /Modules/AHM/MonitoringPointTriggers
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/AHM/MonitoringPointTriggers/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
- POST   /Modules/AHM/MonitoringPointTriggers/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                   API changes are backward compatible                    
--------------------------------------------------------------------------