Add simulated alarm

Add simulated alarm. Users may perform all operations on this alarm, as if it was a regular system generated alarm.

Note: POST calls create new data, and do not affect existing data.

Request
Security:
path Parameters
imei
required
string (IMEI)

The IMEI of the device. The IMEI number can be found on a sticker on the device itself or on the back of the device box.

Example: 357660101000198
Request Body schema: application/json
alarmDefinitionId
required
number (Alarm definition ID)

The ID of the alarm definition.

createdAt
required
string <date-time>

The time stamp for the simulated alarm to be created, in ISO format.

metadata
string

The metadata for the simulated alarm, to include additional information such as explanation. The metadata is automatically added as a comment to the new alarm.

Responses
200

A simulated alarm was created.

304

Alarm was not created because there is an open alarm that is more urgent.

400

Bad request error

401

Unauthorized error

403

Forbidden error

500

Internal server error

post/devices/{imei}/alarm-simulator
Request samples
application/json
{
  • "alarmDefinitionId": 625,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": "string"
}
Response samples
application/json
{
  • "data": {
    },
  • "requestId": "string"
}