Table of Contents

What's New

GET /Modules/AHM/Alarms/Lookups/LookupAlarmAsset

Lookup the Asset for the Alarm.

GET /Modules/AHM/Alarms/Lookups/LookupAlarmWorkOrder

Lookup the Work Order for the Alarm.

POST /Modules/AHM/Alarms/Batch/{alarmIds}/CreateWorkOrder

Batch Create Work Order for Alarms

POST /Modules/AHM/Alarms/{id}/CreateWorkOrder

Create Work Order For Alarm.

GET /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderSection

Lookup the Section for the Alarm Type.

GET /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderTypeOfWork

Lookup the Type of Work for the Alarm Type.

GET /Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderStatus

Lookup the Work Order Status for the Alarm Type.

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)

      • Added property assetId (integer)

      • Added property assetAssetTypeId (integer)

      • Added property assetAssetTypeCode (string)

      • Added property assetAssetTypeDescription (string)

      • Added property assetAssetTypeLastConfirmedOn (string)

      • Added property assetAssetTypeNearestRegularAssetTypeId (integer)

      • Added property assetAssetTypeNearestRegularAssetTypeCode (string)

      • Added property assetAssetTypeNearestRegularAssetTypeDescription (string)

      • Added property assetAssetTypeNearestRegularAssetTypeLastConfirmedOn (string)

      • Added property assetAssetTypeRecordType (string)

      • Added property assetAssetTypeTreePathId (integer)

      • Added property assetAssetTypeTreePathItems (array)

        Items (object):

        • Property sequence (integer)

        • Property code (string)

        • Property description (string)

        • Property alternativeDescription (string)

      • Added property assetCode (string)

      • Added property assetDescription (string)

      • Added property assetDevelopmentStatus (string)

      • Added property assetIsForScheduledWorkOnly (boolean)

      • Added property assetIsMsi (boolean)

      • Added property assetIsPermitRequired (boolean)

      • Added property assetNearestRegularAssetId (integer)

      • Added property assetNearestRegularAssetCode (string)

      • Added property assetNearestRegularAssetDescription (string)

      • Added property assetNearestRegularAssetParentAssetId (integer)

      • Added property assetNearestRegularAssetParentAssetCode (string)

      • Added property assetNearestRegularAssetParentAssetDescription (string)

      • Added property assetNearestRegularAssetSerialNumber (string)

      • Added property assetNearestRegularAssetSiteId (integer)

      • Added property assetNearestRegularAssetSiteCode (string)

      • Added property assetNearestRegularAssetSiteDescription (string)

      • Added property assetRecordType (string)

      • Added property assetSerialNumber (string)

      • Added property assetTreePathId (integer)

      • Added property assetTreePathItems (array)

        Items (object):

        • Property sequence (integer)

        • Property code (string)

        • Property description (string)

        • Property alternativeDescription (string)

      • Added property workOrderId (integer)

      • Added property workOrderCode (string)

      • Added property workOrderDescription (string)

      • Added property workOrderSiteId (integer)

      • Added property workOrderSiteCode (string)

      • Added property workOrderSiteDescription (string)

      • Added property workOrderSiteCurrencyId (integer)

      • Added property workOrderSiteCurrencyCode (string)

      • Added property workOrderSiteCurrencyDescription (string)

      • Added property workOrderCostCentreId (integer)

      • Added property workOrderCostCentreCode (string)

      • Added property workOrderCostCentreDescription (string)

      • Added property workOrderGeneralLedgerId (integer)

      • Added property workOrderGeneralLedgerCode (string)

      • Added property workOrderGeneralLedgerDescription (string)

      • Added property workOrderWorkRequired (string)

      • Added property workOrderStatusId (integer)

      • Added property workOrderStatusCode (string)

      • Added property workOrderStatusDescription (string)

      • Added property workOrderStatusBaseStatus (string)

POST /Modules/AHM/Alarms
Request:

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

  • Changed property properties (object)

    • Added property workOrderId (integer)

    • Added property assetId (integer)

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)

        • Added property assetId (integer)

        • Added property assetCode (string)

        • Added property assetDescription (string)

        • Added property workOrderId (integer)

        • Added property workOrderCode (string)

        • Added property workOrderDescription (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)

        • Added property assetId (integer)

        • Added property assetAssetTypeId (integer)

        • Added property assetAssetTypeCode (string)

        • Added property assetAssetTypeDescription (string)

        • Added property assetAssetTypeLastConfirmedOn (string)

        • Added property assetAssetTypeNearestRegularAssetTypeId (integer)

        • Added property assetAssetTypeNearestRegularAssetTypeCode (string)

        • Added property assetAssetTypeNearestRegularAssetTypeDescription (string)

        • Added property assetAssetTypeNearestRegularAssetTypeLastConfirmedOn (string)

        • Added property assetAssetTypeRecordType (string)

        • Added property assetAssetTypeTreePathId (integer)

        • Added property assetAssetTypeTreePathItems (array)

          Items (object):

          • Property sequence (integer)

          • Property code (string)

          • Property description (string)

          • Property alternativeDescription (string)

        • Added property assetCode (string)

        • Added property assetDescription (string)

        • Added property assetDevelopmentStatus (string)

        • Added property assetIsForScheduledWorkOnly (boolean)

        • Added property assetIsMsi (boolean)

        • Added property assetIsPermitRequired (boolean)

        • Added property assetNearestRegularAssetId (integer)

        • Added property assetNearestRegularAssetCode (string)

        • Added property assetNearestRegularAssetDescription (string)

        • Added property assetNearestRegularAssetParentAssetId (integer)

        • Added property assetNearestRegularAssetParentAssetCode (string)

        • Added property assetNearestRegularAssetParentAssetDescription (string)

        • Added property assetNearestRegularAssetSerialNumber (string)

        • Added property assetNearestRegularAssetSiteId (integer)

        • Added property assetNearestRegularAssetSiteCode (string)

        • Added property assetNearestRegularAssetSiteDescription (string)

        • Added property assetRecordType (string)

        • Added property assetSerialNumber (string)

        • Added property assetTreePathId (integer)

        • Added property assetTreePathItems (array)

          Items (object):

          • Property sequence (integer)

          • Property code (string)

          • Property description (string)

          • Property alternativeDescription (string)

        • Added property workOrderId (integer)

        • Added property workOrderCode (string)

        • Added property workOrderDescription (string)

        • Added property workOrderSiteId (integer)

        • Added property workOrderSiteCode (string)

        • Added property workOrderSiteDescription (string)

        • Added property workOrderSiteCurrencyId (integer)

        • Added property workOrderSiteCurrencyCode (string)

        • Added property workOrderSiteCurrencyDescription (string)

        • Added property workOrderCostCentreId (integer)

        • Added property workOrderCostCentreCode (string)

        • Added property workOrderCostCentreDescription (string)

        • Added property workOrderGeneralLedgerId (integer)

        • Added property workOrderGeneralLedgerCode (string)

        • Added property workOrderGeneralLedgerDescription (string)

        • Added property workOrderWorkRequired (string)

        • Added property workOrderStatusId (integer)

        • Added property workOrderStatusCode (string)

        • Added property workOrderStatusDescription (string)

        • Added property workOrderStatusBaseStatus (string)

POST /Modules/AHM/Alarms/Batch
Request:

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

Changed items (object):

  • Changed property properties (object)

    • Added property workOrderId (integer)

    • Added property assetId (integer)

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

Changed response : 200 OK

Success response - body contains Alarm Type

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

    • Changed property properties (object)

      • Added property autoCreateWorkOrder (boolean)

      • Added property defaultWorkOrderSectionId (integer)

      • Added property defaultWorkOrderSectionCode (string)

      • Added property defaultWorkOrderSectionDescription (string)

      • Added property defaultWorkOrderStatusId (integer)

      • Added property defaultWorkOrderStatusCode (string)

      • Added property defaultWorkOrderStatusDescription (string)

      • Added property defaultWorkOrderStatusBaseStatus (string)

      • Added property defaultWorkOrderTypeOfWorkId (integer)

      • Added property defaultWorkOrderTypeOfWorkCode (string)

      • Added property defaultWorkOrderTypeOfWorkDescription (string)

      • Added property defaultWorkOrderTypeOfWorkWorkType (string)

POST /Modules/AHM/AlarmTypes
Request:

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

  • Changed property properties (object)

    • Added property defaultWorkOrderStatusId (integer)

    • Added property defaultWorkOrderSectionId (integer)

    • Added property defaultWorkOrderTypeOfWorkId (integer)

    • Added property autoCreateWorkOrder (boolean)

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

Changed response : 200 OK

Success response - body contains Alarm Type collection

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

    • Changed property items (array)

      Collection of Alarm Type entities

      Changed items (object):

      • Changed property properties (object)

        • Added property autoCreateWorkOrder (boolean)

        • Added property defaultWorkOrderSectionId (integer)

        • Added property defaultWorkOrderSectionCode (string)

        • Added property defaultWorkOrderSectionDescription (string)

        • Added property defaultWorkOrderStatusId (integer)

        • Added property defaultWorkOrderStatusCode (string)

        • Added property defaultWorkOrderStatusDescription (string)

        • Added property defaultWorkOrderStatusBaseStatus (string)

        • Added property defaultWorkOrderTypeOfWorkId (integer)

        • Added property defaultWorkOrderTypeOfWorkCode (string)

        • Added property defaultWorkOrderTypeOfWorkDescription (string)

        • Added property defaultWorkOrderTypeOfWorkWorkType (string)

POST /Modules/AHM/AlarmTypes/Batch
Request:

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

Changed items (object):

  • Changed property properties (object)

    • Added property defaultWorkOrderStatusId (integer)

    • Added property defaultWorkOrderSectionId (integer)

    • Added property defaultWorkOrderTypeOfWorkId (integer)

    • Added property autoCreateWorkOrder (boolean)

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

Changed response : 200 OK

Success response - body contains Monitoring Point Trigger

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

    • Changed property properties (object)

      • Added property isTemplate (boolean)
POST /Modules/AHM/MonitoringPointTriggers
Request:

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

  • Changed property properties (object)

    • Added property isTemplate (boolean)
GET /Modules/AHM/MonitoringPointTriggers/Batch/{ids}
Return Type:

Changed response : 200 OK

Success response - body contains Monitoring Point Trigger collection

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

    • Changed property items (array)

      Collection of Monitoring Point Trigger entities

      Changed items (object):

      • Changed property properties (object)

        • Added property isTemplate (boolean)
POST /Modules/AHM/MonitoringPointTriggers/Batch
Request:

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

Changed items (object):

  • Changed property properties (object)

    • Added property isTemplate (boolean)