HoxtonAi
Powered by Redocly

Alert Notification Group Mappings

APIs to manage an organisation's alert notification group mappings.

Create/Update alert notification group mapping

Update an alert notification group link if it exists, create a new one otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

The link between an alert and a notification group to store.

alertId
required
string <uuid>
id
string or null <uuid>
notificationGroupId
required
string <uuid>
state
string
Enum: "active" "deleted"
Responses
201

OK.

204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

put/alert-notification-group-mappings
Request samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "notificationGroupId": "41de1f35-974f-4b87-aa3b-73a525fbcbb4",
  • "state": "active"
}
Response samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "notificationGroupId": "41de1f35-974f-4b87-aa3b-73a525fbcbb4",
  • "state": "active"
}

Delete alert notification group mapping

Delete an alert notification group mapping.

Securityo_auth
Request
path Parameters
alertNotificationGroupMappingId
required
string <uuid>

The ID of the alert notification group mapping to be deleted.

Responses
204

OK.

400

Bad request.

401

Authentication failed.

403

Not allowed.

404

Not found.

410

Gone.

422

Unprocessable entity.

500

Failed.

501

Not implemented.

delete/alert-notification-group-mappings/{alertNotificationGroupMappingId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get alert notification group mapping
Get a mapping between an alert and a notification group identified by its id.


Securityo_auth 
Request 
path Parameters
alertNotificationGroupMappingId
required
string <uuid> 
The ID of the alert notification group mapping to get.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-notification-group-mappings/{alertNotificationGroupMappingId}
Request samples 
Response samples 
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "notificationGroupId": "41de1f35-974f-4b87-aa3b-73a525fbcbb4",
  • "state": "active"
}
List alert notification group mappings
Get all available alert notification group mappings subject to filters.


Securityo_auth 
Request 
query Parameters
cameraPositionId
string <uuid> 
The ID of a camera position linked to the alert notification group mapping.


 
notificationGroupId
string <uuid> 
The ID of the notification group the alerts are linked to.


 
alertId
string <uuid> 
The ID of the alert the notification groups are linked to.


 
organisationId
string <uuid> 
The ID of the associated organisation.


 
state
string
The state of the alert notification group mapping.


 Enum: "active" "deleted"  
occupancyMonitorId
string <uuid> 
the ID of the occupancy monitor the alert is mapped to.


 
alertType
string
The ID of a camera linked to the Alerts.


 Enum: "offline_alert" "occupancy_alert" "camera_health_summary_alert"  
siteId
string <uuid> 
the ID of the site the alert rule mapping is part of.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-notification-group-mappings
Request samples 
Response samples 
application/json
[
  • {
    }
]