HoxtonAi
Powered by Redocly

Alert Occupancy Monitor Mappings

APIs to manage an organisation's alert occupancy monitor mappings.

Create/Update alert occupancy monitor mapping

Update an occupancy monitor to alert mapping if it exists, create a new object linking the given occupancy monitor to the given alert otherwise.

Securityo_auth
Request
Request Body schema: application/json
required

An occupancy monitor to alert mapping.

alertId
required
string <uuid>
id
string or null <uuid>
occupancyMonitorId
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-occupancy-monitor-mappings
Request samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}
Response samples
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}

Delete alert occupancy monitor mapping

Set the state of an occupancy monitor to alert mapping to deleted.

Securityo_auth
Request
path Parameters
alertOccupancyMonitorMappingId
required
string <uuid>

the ID of the occupancy monitor to alert mapping to delete.

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-occupancy-monitor-mappings/{alertOccupancyMonitorMappingId}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string"
}
Get alert occupancy monitor mapping
Get an occupancy monitor to alert mapping identified by the provided ID.


Securityo_auth 
Request 
path Parameters
alertOccupancyMonitorMappingId
required
string <uuid> 
The ID of the occupancy monitor to alert mapping.


 
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


404
Not found.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-occupancy-monitor-mappings/{alertOccupancyMonitorMappingId}
Request samples 
Response samples 
application/json
{
  • "alertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "occupancyMonitorId": "51bf4310-39f9-49d3-99c1-c643ff9c2f04",
  • "state": "active"
}
List alert occupancy monitor mappings
Get all links between occupancy monitors and alert subject to filters.


Securityo_auth 
Request 
query Parameters
occupancyMonitorId
string <uuid> 
the ID of the occupancy monitor the alert is mapped to.


 
alertId
string <uuid> 
the ID of the alert the occupancy monitors are mapped to.


 
siteId
string <uuid> 
the ID of the site the monitor alert rule mapping is part of.


 
organisationId
string <uuid> 
the ID of the organisation the site of the monitor alert rule mapping is part of.


 
state
string
Occupancy monitor alert state.


 Enum: "active" "deleted"  
Responses 
200
OK.


401
Authentication failed.


403
Not allowed.


422
Unprocessable entity.


500
Failed.


501
Not implemented.


get/alert-occupancy-monitor-mappings
Request samples 
Response samples 
application/json
[
  • {
    }
]