Table of Contents

What's New

GET /Modules/AHM/Alarms/AlarmTypes/{id}

Get a Alarm Alarm Type resource.

DELETE /Modules/AHM/Alarms/AlarmTypes/{id}

Delete an existing Alarm Alarm Type resource.

GET /Modules/AHM/Alarms/AlarmTypes

Get a collection of Alarm Alarm Type resources.

POST /Modules/AHM/Alarms/AlarmTypes

Create a new Alarm Alarm Type resource.

GET /Modules/AHM/Alarms/{alarmId}/AlarmAlarmType

Get a collection of Alarm Alarm Type resources for the Alarm.

GET /Modules/AHM/Alarms/AlarmTypes/Lookups/LookupAlarmAlarmTypeAlarm

Lookup the Alarm Alarm Type for the Alarm Alarm Type.

GET /Modules/AHM/Alarms/AlarmTypes/Lookups/LookupAlarmAlarmTypeAlarmType

Lookup the Alarm Alarm Type for the Alarm Alarm Type.

GET /Modules/AHM/Alarms/AlarmTypes/Batch/{ids}

Get a collection of Alarm Alarm Type resources for the set of id's.

POST /Modules/AHM/Alarms/AlarmTypes/Batch

Create a new collection of Alarm Alarm Type resources.

DELETE /Modules/AHM/Alarms/AlarmTypes/Batch

Delete a collection of existing Alarm Alarm Type resources.

GET /Modules/AHM/Alarms/Expressions/{id}

Get a Alarm Expression resource.

GET /Modules/AHM/Alarms/Expressions

Get a collection of Alarm Expression resources.

GET /Modules/AHM/Alarms/{alarmId}/Expression

Get a collection of Alarm Expression resources for the Alarm.

GET /Modules/AHM/Alarms/Expressions/Batch/{ids}

Get a collection of Alarm Expression resources for the set of id's.

GET /Modules/AHM/Alarms/Expressions/Tasks/{id}

Get a Alarm Expression Task resource.

GET /Modules/AHM/Alarms/Expressions/{alarmExpressionId}/Task

Get a collection of Alarm Expression Task resources for the Alarm.

GET /Modules/AHM/Alarms/Expressions/Tasks

Get a collection of Alarm Expression Task resources.

GET /Modules/AHM/Alarms/Expressions/Tasks/Batch/{ids}

Get a collection of Alarm Expression Task resources for the set of id's.

What's Deleted

GET /Modules/AHM/Alarms/Lookups/LookupAlarmMonitoringPointTriggerExpression

Lookup the Monitoring Point Trigger Expression for the Alarm.

GET /Modules/AHM/Alarms/Lookups/LookupAlarmWorkOrder

Lookup the Work Order for the Alarm.

What's Changed

GET /Modules/AHM/Alarms/{id}
Return Type:

Changed response : 200 OK

Success response - body contains Alarm

  • Changed content type : application/vnd.onkey.entity+json

    • Changed property properties (object)

      • Deleted property alarmTypeId (integer)

      • Deleted property alarmTypeCode (string)

      • Deleted property alarmTypeDescription (string)

      • Deleted property monitoringPointTriggerExpressionId (integer)

      • Deleted property monitoringPointTriggerExpressionDescription (string)

      • Deleted property monitoringPointTriggerExpressionExpression (string)

      • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)

      • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)

      • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerDescription (string)

      • Deleted property workOrderId (integer)

      • Deleted property workOrderCode (string)

      • Deleted property workOrderDescription (string)

      • Deleted property workOrderSiteId (integer)

      • Deleted property workOrderSiteCode (string)

      • Deleted property workOrderSiteDescription (string)

      • Deleted property workOrderSiteCurrencyId (integer)

      • Deleted property workOrderSiteCurrencyCode (string)

      • Deleted property workOrderSiteCurrencyDescription (string)

      • Deleted property workOrderCostCentreId (integer)

      • Deleted property workOrderCostCentreCode (string)

      • Deleted property workOrderCostCentreDescription (string)

      • Deleted property workOrderGeneralLedgerId (integer)

      • Deleted property workOrderGeneralLedgerCode (string)

      • Deleted property workOrderGeneralLedgerDescription (string)

      • Deleted property workOrderWorkRequired (string)

      • Deleted property workOrderStatusId (integer)

      • Deleted property workOrderStatusCode (string)

      • Deleted property workOrderStatusDescription (string)

      • Deleted property workOrderStatusBaseStatus (string)

GET /Modules/AHM/Alarms
Return Type:

Changed response : 200 OK

Success response - body contains pageable Alarm collection

  • Changed content type : application/vnd.onkey.entitycollectionpage+json

    • Changed property items (array)

      Pageable collection of entities

      Changed items (object):

      • Changed property properties (object)

        • Deleted property alarmTypeId (integer)

        • Deleted property alarmTypeCode (string)

        • Deleted property alarmTypeDescription (string)

        • Deleted property workOrderId (integer)

        • Deleted property workOrderCode (string)

        • Deleted property workOrderDescription (string)

        • Deleted property monitoringPointTriggerExpressionId (integer)

        • Deleted property monitoringPointTriggerExpressionDescription (string)

        • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)

        • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)

POST /Modules/AHM/Alarms
Request:

Changed content type : application/vnd.onkey.entity+json

  • Changed property properties (object)

    • Deleted property workOrderId (integer)

    • Changed property description (string)

GET /Modules/AHM/Alarms/Batch/{ids}
Return Type:

Changed response : 200 OK

Success response - body contains Alarm collection

  • Changed content type : application/vnd.onkey.entitycollection+json

    • Changed property items (array)

      Collection of Alarm entities

      Changed items (object):

      • Changed property properties (object)

        • Deleted property alarmTypeId (integer)

        • Deleted property alarmTypeCode (string)

        • Deleted property alarmTypeDescription (string)

        • Deleted property monitoringPointTriggerExpressionId (integer)

        • Deleted property monitoringPointTriggerExpressionDescription (string)

        • Deleted property monitoringPointTriggerExpressionExpression (string)

        • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerId (integer)

        • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerCode (string)

        • Deleted property monitoringPointTriggerExpressionMonitoringPointTriggerDescription (string)

        • Deleted property workOrderId (integer)

        • Deleted property workOrderCode (string)

        • Deleted property workOrderDescription (string)

        • Deleted property workOrderSiteId (integer)

        • Deleted property workOrderSiteCode (string)

        • Deleted property workOrderSiteDescription (string)

        • Deleted property workOrderSiteCurrencyId (integer)

        • Deleted property workOrderSiteCurrencyCode (string)

        • Deleted property workOrderSiteCurrencyDescription (string)

        • Deleted property workOrderCostCentreId (integer)

        • Deleted property workOrderCostCentreCode (string)

        • Deleted property workOrderCostCentreDescription (string)

        • Deleted property workOrderGeneralLedgerId (integer)

        • Deleted property workOrderGeneralLedgerCode (string)

        • Deleted property workOrderGeneralLedgerDescription (string)

        • Deleted property workOrderWorkRequired (string)

        • Deleted property workOrderStatusId (integer)

        • Deleted property workOrderStatusCode (string)

        • Deleted property workOrderStatusDescription (string)

        • Deleted property workOrderStatusBaseStatus (string)

POST /Modules/AHM/Alarms/Batch
Request:

Changed content type : application/vnd.onkey.entitycollection+json

Changed items (object):

  • Changed property properties (object)

    • Deleted property workOrderId (integer)

    • Changed property description (string)