streamId required | string Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb The stream identifier that contains the subscription. This is the unique
+ {"responses": [{"responseId": "1", "status": 204 }, {"responseId": "2", "status": 400 }, {"responseId": "3", "status": 204 }, {"responseId": "4", "status": 400 } ] } Delete activities subscription Deletes a subscription to the activities resource.
+ path ParametersstreamId required | string Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb The stream identifier that contains the subscription. This is the unique
identifier for the client's stream obtained via GET /stream .
- | subscriptionId required | string Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5 The identifier of the subscription to act upon. This is the unique
+ | subscriptionId required | string Example: 626e5ac3-506d-4017-bb8f-973f1c54ddb5 The identifier of the subscription to act upon. This is the unique
identifier to the subscription for a specific resource or type of event.
This value is found as the last parameter of a
METASYS-SUBSCRIPTION-LOCATION header returned for the original
subscription request.
- |
ResponsesThe base URL of all API routes
- https://{hostname}/api/v4/activities/streams/{streamId}/subscriptions/{subscriptionId} Request samples - Shell + Curl
- Csharp + Restsharp
- Javascript + Xhr
- Node + Native
- Python + Python3
- Ruby + Native
curl --request DELETE \
- --url https:/
- --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' Alarms alert users to potential problems identified by a Metasys system, for example high zone temperatures. Use alarms operations to get object alarms, network device alarms, single alarms, alarm collections, and alarm annotations. Acknowledge or discard alarms with the edit patch operation. Filter the results with the query parameters time, priority, type, category, acknowledgement, and page. Sort the results by creation time and priority.
- Get alarms for an object Retrieves a collection of alarms for the specified object.
- path ParametersobjectId required | string Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb The identifier of the object.
- |
query ParametersstartTime | string <date-time> Example: startTime=2018-05-21T13:58:20.243Z Only include results generated on or after this date-time.
- | endTime | string <date-time> Example: endTime=2018-05-21T13:58:20.243Z Only include results generated on or before this date-time.
- | priorityRange | string^\d+,\d+$ Example: priorityRange=0,255 Includes only results within the specified alarm priority range, from 0 to 255 inclusive.
- | type | Array of strings[ items <= 100 items ] Example: type=alarmValueEnumSet.avHighLimit metasysEnum: alarmValueEnumSet Limits the alarms returned to specified types.
+ |
ResponsesThe base URL of all API routes
+ https://{hostname}/api/v4/activities/streams/{streamId}/subscriptions/{subscriptionId} Request samples - Shell + Curl
- Csharp + Restsharp
- Javascript + Xhr
- Node + Native
- Python + Python3
- Ruby + Native
curl --request DELETE \
+ --url https://metasys-server.example.com/api/v4/activities/streams/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/subscriptions/626e5ac3-506d-4017-bb8f-973f1c54ddb5 \
+ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' Alarms alert users to potential problems identified by a Metasys system, for example high zone temperatures. Use alarms operations to get object alarms, network device alarms, single alarms, alarm collections, and alarm annotations. Acknowledge or discard alarms with the edit patch operation. Filter the results with the query parameters time, priority, type, category, acknowledgement, and page. Sort the results by creation time and priority.
+ Get alarms for an object Retrieves a collection of alarms for the specified object.
+ path ParametersobjectId required | string Example: 32cfddc0-411f-5b9e-9a6d-442cb62fecbb The identifier of the object.
+ |
query ParametersstartTime | string <date-time> Example: startTime=2018-05-21T13:58:20.243Z Only include results generated on or after this date-time.
+ | endTime | string <date-time> Example: endTime=2018-05-21T13:58:20.243Z Only include results generated on or before this date-time.
+ | priorityRange | string^\d+,\d+$ Example: priorityRange=0,255 Includes only results within the specified alarm priority range, from 0 to 255 inclusive.
+ | type | Array of strings[ items <= 100 items ] Example: type=alarmValueEnumSet.avHighLimit metasysEnum: alarmValueEnumSet Limits the alarms returned to specified types.
The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration.
Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit ) is accepted.
Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet .
@@ -3141,7 +2158,17 @@ Filter Behavior
- | includeAcknowledged | boolean Determines whether acknowledged alarms will be included in the results or be
+ | includeAcknowledged | boolean Determines whether acknowledged alarms will be included in the results or be
the only type of alarm in the results. Acknowledged alarms are those which
have an acknowledgedTime value set.
This parameter can produce 3 different types of results.
@@ -3151,7 +2178,17 @@ Filter Behavior
missing - (default) Acknowledged status is ignored; both acknowledged
and non-acknowledged alarms are returned.
- | includeDiscarded | boolean Determines whether discarded alarms will be included in the results or be
+ | includeDiscarded | boolean Determines whether discarded alarms will be included in the results or be
the only type of alarm in the results. Discarded alarms are those for which
the activityManagementStatus is discarded . This parameter can produce 3
different types of results.
@@ -3161,9 +2198,19 @@ Filter Behavior
missing - (default) Discarded status is ignored; both discarded and
non-discarded alarms are returned.
- | includeAcknowledgementRequired | boolean Default: true Example: includeAcknowledgementRequired=true Determines whether alarms which can be acknowledged are included in the results. When the value is true , alarms which can be acknowledged will be included in the results. When false , alarms which can be acknowledged will not be included in the results.
- | includeAcknowledgementNotRequired | boolean Default: true Example: includeAcknowledgementNotRequired=true Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.
- | category | Array of strings Example: category=objectCategoryEnumSet.hvacCategory metasysEnum: objectCategoryEnumSet The authorization category of the requested activities.
+ | includeAcknowledgementRequired | boolean Default: true Example: includeAcknowledgementRequired=true Determines whether alarms which can be acknowledged are included in the results. When the value is true , alarms which can be acknowledged will be included in the results. When false , alarms which can be acknowledged will not be included in the results.
+ | includeAcknowledgementNotRequired | boolean Default: true Example: includeAcknowledgementNotRequired=true Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.
+ | category | Array of strings Example: category=objectCategoryEnumSet.hvacCategory metasysEnum: objectCategoryEnumSet The authorization category of the requested activities.
The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration.
Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory ) is accepted.
Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet .
@@ -3171,20 +2218,39 @@ Filter Behavior
- | page | integer >= 1 Default: 1 Example: page=1 The page number of items to return.
- | pageSize | integer [ 1 .. 10000 ] Default: 100 Example: pageSize=100 The maximum number of items to return in the response.
- | sort | string Default: "creationTime" Enum: "creationTime" "-creationTime" "priority" "-priority" Example: sort=creationTime The criteria to use when sorting results (see rules).
- |
The base URL of all API routes
- https://{hostname}/api/v4/objects/{objectId}/alarms Request samples - Shell + Curl
- Csharp + Restsharp
- Javascript + Xhr
- Node + Native
- Python + Python3
- Ruby + Native
curl --request GET \
- --url 'https:///%7Bhostname%7D/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
- --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' Response samples Content typeapplication/vnd.metasysapi.v4+json {"total": 403, "previous": null, "items": [{"id": "4d0598d4-2836-4efd-84b8-6f39754b1fc5", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T17:00:07Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "999235c5-9f4a-42f9-8ea5-863cc6a08eed", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "6e1d7f3b-226b-4b36-811f-849d8e32810d", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T16:59:52Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "991cfa4b-e1c2-4e79-b309-903acebc8a65", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "78271a1f-5985-441e-9893-4c887259d9c6", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-30T17:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "f281f4aa-56d3-4e5d-bf23-c4e61e439c08", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-30T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "41621c0a-a369-44d1-8b41-ef0ac2b3977a", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-29T16:59:59Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "ed778832-f47a-436f-8fde-fd38f7af73bc", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-29T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "54a7fda0-87f4-4ce1-a2de-b19a25186dee", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-28T16:59:59Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "df0f6135-359c-4d69-9645-36fa2a5a2c13", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "discardedTime": "2021-08-28T21:32:42.247Z", "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-28T05:00:00Z", "activityManagementStatus": "discarded", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] } ], "effectivePermissions": [], } Get alarms for a network device Retrieves a collection of alarms for the specified network device.
- path ParametersnetworkDeviceId required | string Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7 The identifier of a network device.
- |
query ParametersstartTime | string <date-time> Example: startTime=2018-05-21T13:58:20.243Z Only include results generated on or after this date-time.
- | endTime | string <date-time> Example: endTime=2018-05-21T13:58:20.243Z Only include results generated on or before this date-time.
- | priorityRange | string^\d+,\d+$ Example: priorityRange=0,255 Includes only results within the specified alarm priority range, from 0 to 255 inclusive.
- | type | Array of strings[ items <= 100 items ] Example: type=alarmValueEnumSet.avHighLimit metasysEnum: alarmValueEnumSet Limits the alarms returned to specified types.
+ | page | integer >= 1 Default: 1 Example: page=1 The page number of items to return.
+ | pageSize | integer [ 1 .. 10000 ] Default: 100 Example: pageSize=100 The maximum number of items to return in the response.
+ | sort | string Default: "creationTime" Enum: "creationTime" "-creationTime" "priority" "-priority" Example: sort=creationTime The criteria to use when sorting results (see rules).
+ |
The base URL of all API routes
+ https://{hostname}/api/v4/objects/{objectId}/alarms Request samples - Shell + Curl
- Csharp + Restsharp
- Javascript + Xhr
- Node + Native
- Python + Python3
- Ruby + Native
curl --request GET \
+ --url 'https://metasys-server.example.com/api/v4/objects/32cfddc0-411f-5b9e-9a6d-442cb62fecbb/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
+ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' Response samples Content typeapplication/vnd.metasysapi.v4+json {"total": 403, "previous": null, "items": [{"id": "4d0598d4-2836-4efd-84b8-6f39754b1fc5", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T17:00:07Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "999235c5-9f4a-42f9-8ea5-863cc6a08eed", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "6e1d7f3b-226b-4b36-811f-849d8e32810d", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T16:59:52Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "991cfa4b-e1c2-4e79-b309-903acebc8a65", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "78271a1f-5985-441e-9893-4c887259d9c6", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-30T17:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "f281f4aa-56d3-4e5d-bf23-c4e61e439c08", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-30T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "41621c0a-a369-44d1-8b41-ef0ac2b3977a", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-29T16:59:59Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "ed778832-f47a-436f-8fde-fd38f7af73bc", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-29T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "54a7fda0-87f4-4ce1-a2de-b19a25186dee", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-28T16:59:59Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "df0f6135-359c-4d69-9645-36fa2a5a2c13", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "discardedTime": "2021-08-28T21:32:42.247Z", "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-28T05:00:00Z", "activityManagementStatus": "discarded", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] } ], "effectivePermissions": [], } Get alarms for a network device Retrieves a collection of alarms for the specified network device.
+ path ParametersnetworkDeviceId required | string Example: d9bf66bd-22f8-425b-82a4-44ba153d79c7 The identifier of a network device.
+ |
query ParametersstartTime | string <date-time> Example: startTime=2018-05-21T13:58:20.243Z Only include results generated on or after this date-time.
+ | endTime | string <date-time> Example: endTime=2018-05-21T13:58:20.243Z Only include results generated on or before this date-time.
+ | priorityRange | string^\d+,\d+$ Example: priorityRange=0,255 Includes only results within the specified alarm priority range, from 0 to 255 inclusive.
+ | type | Array of strings[ items <= 100 items ] Example: type=alarmValueEnumSet.avHighLimit metasysEnum: alarmValueEnumSet Limits the alarms returned to specified types.
The acceptable values for the elements of this parameter come from the alarmValueEnumSet enumeration.
Only the long name of the alarm value (for example, alarmValueEnumSet.avHighLimit instead of avHighLimit ) is accepted.
Find the definition of alarmValueEnumSet at the relative URL of /schemas/enums/alarmValueEnumSet .
@@ -3192,7 +2258,17 @@ Filter Behavior
- | includeAcknowledged | boolean Determines whether acknowledged alarms will be included in the results or be
+ | includeAcknowledged | boolean Determines whether acknowledged alarms will be included in the results or be
the only type of alarm in the results. Acknowledged alarms are those which
have an acknowledgedTime value set.
This parameter can produce 3 different types of results.
@@ -3202,7 +2278,17 @@ Filter Behavior
missing - (default) Acknowledged status is ignored; both acknowledged
and non-acknowledged alarms are returned.
- | includeDiscarded | boolean Determines whether discarded alarms will be included in the results or be
+ | includeDiscarded | boolean Determines whether discarded alarms will be included in the results or be
the only type of alarm in the results. Discarded alarms are those for which
the activityManagementStatus is discarded . This parameter can produce 3
different types of results.
@@ -3212,12 +2298,25 @@ Filter Behavior
missing - (default) Discarded status is ignored; both discarded and
non-discarded alarms are returned.
- | includeAcknowledgementRequired | boolean Default: true Example: includeAcknowledgementRequired=true Determines whether alarms which can be acknowledged are included in the results. When the value is true , alarms which can be acknowledged will be included in the results. When false , alarms which can be acknowledged will not be included in the results.
- | includeAcknowledgementNotRequired | boolean Default: true Example: includeAcknowledgementNotRequired=true Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.
- | equipment | Array of strings <= 100 items Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398 Filter by list of equipment identifiers.
- | object | Array of strings <= 100 items Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7 Filter by list of object identifiers.
- | space | Array of strings <= 100 items Example: space=214f52d1-0c56-4a29-a690-abe5656d1647 Filter by list of space identifiers.
- | category | Array of strings Example: category=objectCategoryEnumSet.hvacCategory metasysEnum: objectCategoryEnumSet The authorization category of the requested activities.
+ | includeAcknowledgementRequired | boolean Default: true Example: includeAcknowledgementRequired=true Determines whether alarms which can be acknowledged are included in the results. When the value is true , alarms which can be acknowledged will be included in the results. When false , alarms which can be acknowledged will not be included in the results.
+ | includeAcknowledgementNotRequired | boolean Default: true Example: includeAcknowledgementNotRequired=true Determines whether alarms which can not be acknowledged are included in the results. When the value is true then the results will include alarms which cannot be acknowledged. When the value is false then the results will not include alarms which cannot be acknowledged.
+ | equipment | Array of strings <= 100 items Example: equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398 Filter by list of equipment identifiers.
+ | object | Array of strings <= 100 items Example: object=06d77c63-6357-467a-a306-5e1ab3eb3aa7 Filter by list of object identifiers.
+ | space | Array of strings <= 100 items Example: space=214f52d1-0c56-4a29-a690-abe5656d1647 Filter by list of space identifiers.
+ | category | Array of strings Example: category=objectCategoryEnumSet.hvacCategory metasysEnum: objectCategoryEnumSet The authorization category of the requested activities.
The acceptable values for the elements of this parameter come from the objectCategoryEnumSet enumeration.
Only the long name of the object category (for example, objectCategoryEnumSet.hvacCategory instead of hvacCategory ) is accepted.
Find the definition of objectCategoryEnumSet at the relative URL of /schemas/enums/objectCategoryEnumSet .
@@ -3225,25 +2324,49 @@ Filter Behavior
- | page | integer >= 1 Default: 1 Example: page=1 The page number of items to return.
- | pageSize | integer [ 1 .. 10000 ] Default: 100 Example: pageSize=100 The maximum number of items to return in the response.
- | sort | string Default: "creationTime" Enum: "creationTime" "-creationTime" "priority" "-priority" Example: sort=creationTime The criteria to use when sorting results (see rules).
- |
The base URL of all API routes
- https://{hostname}/api/v4/networkDevices/{networkDeviceId}/alarms Request samples - Shell + Curl
- Csharp + Restsharp
- Javascript + Xhr
- Node + Native
- Python + Python3
- Ruby + Native
curl --request GET \
- --url 'https:///%7Bhostname%7D/api/v4/networkDevices/d9bf66bd-22f8-425b-82a4-44ba153d79c7/alarms?startTime=2018-05-21T13%3A58%3A20.243Z&endTime=2018-05-21T13%3A58%3A20.243Z&priorityRange=0%2C255&type=alarmValueEnumSet.avHighLimit&includeAcknowledged=false&includeDiscarded=false&includeAcknowledgementRequired=true&includeAcknowledgementNotRequired=true&equipment=b7ed8b3e-cb95-410d-aaa7-37158852c398&object=06d77c63-6357-467a-a306-5e1ab3eb3aa7&space=214f52d1-0c56-4a29-a690-abe5656d1647&category=objectCategoryEnumSet.hvacCategory&page=1&pageSize=100&sort=creationTime' \
- --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' Response samples Content typeapplication/vnd.metasysapi.v4+json {"total": 9027, "previous": null, "items": [{"id": "4d0598d4-2836-4efd-84b8-6f39754b1fc5", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T17:00:07Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "cbc0a848-9231-4608-b958-276d3f2e9f3e", "itemReference": "{hostname}:{deviceHostname}", "description": "", "name": "My Engine", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "creationTime": "2021-09-01T05:02:03Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null }, {"id": "673c8b44-8667-4216-8856-e0d6c41aea6c", "itemReference": "{hostname}:{deviceHostname}", "description": "", "name": "My Engine", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avAlarm", "priority": 70, "creationTime": "2021-09-01T05:02:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null }, {"id": "999235c5-9f4a-42f9-8ea5-863cc6a08eed", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avLoAlarm", "priority": 70, "triggerValue": {"item": "0.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-09-01T05:00:00Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "6e1d7f3b-226b-4b36-811f-849d8e32810d", "itemReference": "{hostname}:{deviceHostname}/AV2", "description": "", "name": "AV2", "message": "", "isAckRequired": false, "type": "alarmValueEnumSet.avNormal", "priority": 200, "triggerValue": {"item": "1.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T16:59:52Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.administrativeCategory", "annotationsUrl": null, "spaces": [{"id": "d4c025db-db0e-56dc-910b-aa1d7bdbd723", "itemReference": "{hostname}:{deviceHostname}/Campus.Building.Floor 1", "name": "Floor 1", } ], "equipment": [{"id": "d40e96c6-d474-5aaf-be85-cfcbabb30334", "itemReference": "{hostname}:{deviceHostname}/equipment.My Engine", "equipmentName": "AHU", "shortName": "AV2", } ] }, {"id": "f58f0068-f84a-4648-8ae7-bdf66c60994f", "itemReference": "{hostname}:{deviceHostname}", "description": "", "name": "My Engine", "message": "{hostname}:{deviceHostname} is online", "isAckRequired": true, "type": "alarmValueEnumSet.avOnline", "priority": 106, "triggerValue": {"item": "", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T13:19:35Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null }, {"id": "243e039d-0cf0-4efb-a88f-5ff342d45c95", "itemReference": "{hostname}:{deviceHostname}", "description": "", "name": "My Engine", "message": "{hostname}:{deviceHostname} is offline", "isAckRequired": true, "type": "alarmValueEnumSet.avOffline", "priority": 106, "triggerValue": {"item": "", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T13:19:25Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null }, {"id": "dfc444d7-1a6c-4ae2-9347-8d8acf7f349a", "itemReference": "{hostname}:{deviceHostname}", "description": "", "name": "My Site Director", "message": "{hostname}:{deviceHostname} is online", "isAckRequired": true, "type": "alarmValueEnumSet.avOnline", "priority": 106, "triggerValue": {"item": "", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T13:19:24Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null }, {"id": "ddf30e8e-ff6e-4036-b067-6e2617fa8244", "itemReference": "{hostname}:{deviceHostname}/AV3", "description": "", "name": "AV3", "alarmGeneratorObject": {}, "message": "", "isAckRequired": true, "type": "alarmValueEnumSet.avUnreliable", "priority": 70, "triggerValue": {"item": "2.0", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T13:19:22Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.generalCategory", "annotationsUrl": null }, {"id": "5b9a300d-d953-4e8f-902f-84da1c3d0deb", "itemReference": "{hostname}:{deviceHostname}", "description": "Dormant User Account", "name": "User Account I18NUser on device My Site Director", "message": "User Account has been unused or has not successfully logged in since 45 day(s)", "isAckRequired": true, "type": "alarmValueEnumSet.avAlarm", "priority": 220, "triggerValue": {"item": "66", "schema": {"type": "string", "metasysType": "string", } }, "creationTime": "2021-08-31T12:53:53.977Z", "activityManagementStatus": "pending", "category": "objectCategoryEnumSet.systemCategory", "annotationsUrl": null } ], "effectivePermissions": [], } Get alarms Deprecated Retrieves a collection of alarms.
+ |