AHM API Changes

Warning

Some API changes are not backward compatible
Breaking Changes

Path	Description
`GET /Modules/AHM/Alarms`	Condition monitoring redesign
`GET /Modules/AHM/Alarms/{id}`	Condition monitoring redesign
`GET /Modules/AHM/Alarms/Batch/{ids}`	Condition monitoring redesign
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/AlarmTypes/{id}
- DELETE /Modules/AHM/Alarms/AlarmTypes/{id}
- GET    /Modules/AHM/Alarms/AlarmTypes
- POST   /Modules/AHM/Alarms/AlarmTypes
- GET    /Modules/AHM/Alarms/{alarmId}/AlarmAlarmType
- GET    /Modules/AHM/Alarms/AlarmTypes/Lookups/LookupAlarmAlarmTypeAlarm
- GET    /Modules/AHM/Alarms/AlarmTypes/Lookups/LookupAlarmAlarmTypeAlarmType
- GET    /Modules/AHM/Alarms/AlarmTypes/Batch/{ids}
- POST   /Modules/AHM/Alarms/AlarmTypes/Batch
- DELETE /Modules/AHM/Alarms/AlarmTypes/Batch
- GET    /Modules/AHM/Alarms/Expressions/{id}
- GET    /Modules/AHM/Alarms/Expressions
- GET    /Modules/AHM/Alarms/{alarmId}/Expression
- GET    /Modules/AHM/Alarms/Expressions/Batch/{ids}
- GET    /Modules/AHM/Alarms/Expressions/Tasks/{id}
- GET    /Modules/AHM/Alarms/Expressions/{alarmExpressionId}/Task
- GET    /Modules/AHM/Alarms/Expressions/Tasks
- GET    /Modules/AHM/Alarms/Expressions/Tasks/Batch/{ids}

--------------------------------------------------------------------------
--                            What's Deleted                            --
--------------------------------------------------------------------------
- GET    /Modules/AHM/Alarms/Lookups/LookupAlarmMonitoringPointTriggerExpression
- GET    /Modules/AHM/Alarms/Lookups/LookupAlarmWorkOrder

--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
- GET    /Modules/AHM/Alarms/{id}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entity+json
          Schema: Broken compatibility
          Missing property: properties.alarmTypeId (integer)
          Missing property: properties.alarmTypeCode (string)
          Missing property: properties.alarmTypeDescription (string)
          Missing property: properties.monitoringPointTriggerExpressionId (integer)
          Missing property: properties.monitoringPointTriggerExpressionDescription (string)
          Missing property: properties.monitoringPointTriggerExpressionExpression (string)
          Missing property: properties.monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)
          Missing property: properties.monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)
          Missing property: properties.monitoringPointTriggerExpressionMonitoringPointTriggerDescription (string)
          Missing property: properties.workOrderId (integer)
          Missing property: properties.workOrderCode (string)
          Missing property: properties.workOrderDescription (string)
          Missing property: properties.workOrderSiteId (integer)
          Missing property: properties.workOrderSiteCode (string)
          Missing property: properties.workOrderSiteDescription (string)
          Missing property: properties.workOrderSiteCurrencyId (integer)
          Missing property: properties.workOrderSiteCurrencyCode (string)
          Missing property: properties.workOrderSiteCurrencyDescription (string)
          Missing property: properties.workOrderCostCentreId (integer)
          Missing property: properties.workOrderCostCentreCode (string)
          Missing property: properties.workOrderCostCentreDescription (string)
          Missing property: properties.workOrderGeneralLedgerId (integer)
          Missing property: properties.workOrderGeneralLedgerCode (string)
          Missing property: properties.workOrderGeneralLedgerDescription (string)
          Missing property: properties.workOrderWorkRequired (string)
          Missing property: properties.workOrderStatusId (integer)
          Missing property: properties.workOrderStatusCode (string)
          Missing property: properties.workOrderStatusDescription (string)
          Missing property: properties.workOrderStatusBaseStatus (string)
- GET    /Modules/AHM/Alarms
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollectionpage+json
          Schema: Broken compatibility
          Missing property: items[n].properties.alarmTypeId (integer)
          Missing property: items[n].properties.alarmTypeCode (string)
          Missing property: items[n].properties.alarmTypeDescription (string)
          Missing property: items[n].properties.workOrderId (integer)
          Missing property: items[n].properties.workOrderCode (string)
          Missing property: items[n].properties.workOrderDescription (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionId (integer)
          Missing property: items[n].properties.monitoringPointTriggerExpressionDescription (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)
          Missing property: items[n].properties.monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)
- POST   /Modules/AHM/Alarms
  Request:
        - Changed application/vnd.onkey.entity+json
          Schema: Backward compatible
- GET    /Modules/AHM/Alarms/Batch/{ids}
  Return Type:
    - Changed 200 OK
      Media types:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Broken compatibility
          Missing property: items[n].properties.alarmTypeId (integer)
          Missing property: items[n].properties.alarmTypeCode (string)
          Missing property: items[n].properties.alarmTypeDescription (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionId (integer)
          Missing property: items[n].properties.monitoringPointTriggerExpressionDescription (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionExpression (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)
          Missing property: items[n].properties.monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)
          Missing property: items[n].properties.monitoringPointTriggerExpressionMonitoringPointTriggerDescription (string)
          Missing property: items[n].properties.workOrderId (integer)
          Missing property: items[n].properties.workOrderCode (string)
          Missing property: items[n].properties.workOrderDescription (string)
          Missing property: items[n].properties.workOrderSiteId (integer)
          Missing property: items[n].properties.workOrderSiteCode (string)
          Missing property: items[n].properties.workOrderSiteDescription (string)
          Missing property: items[n].properties.workOrderSiteCurrencyId (integer)
          Missing property: items[n].properties.workOrderSiteCurrencyCode (string)
          Missing property: items[n].properties.workOrderSiteCurrencyDescription (string)
          Missing property: items[n].properties.workOrderCostCentreId (integer)
          Missing property: items[n].properties.workOrderCostCentreCode (string)
          Missing property: items[n].properties.workOrderCostCentreDescription (string)
          Missing property: items[n].properties.workOrderGeneralLedgerId (integer)
          Missing property: items[n].properties.workOrderGeneralLedgerCode (string)
          Missing property: items[n].properties.workOrderGeneralLedgerDescription (string)
          Missing property: items[n].properties.workOrderWorkRequired (string)
          Missing property: items[n].properties.workOrderStatusId (integer)
          Missing property: items[n].properties.workOrderStatusCode (string)
          Missing property: items[n].properties.workOrderStatusDescription (string)
          Missing property: items[n].properties.workOrderStatusBaseStatus (string)
- POST   /Modules/AHM/Alarms/Batch
  Request:
        - Changed application/vnd.onkey.entitycollection+json
          Schema: Backward compatible
--------------------------------------------------------------------------
--                                Result                                --
--------------------------------------------------------------------------
                 API changes broke backward compatibility                 
--------------------------------------------------------------------------
Table of Contents

AHM API Changes

Warning

Breaking Changes

Changelog
