Перейти к основному содержимому

Оповещения API 1.5.0

События оповещений, ошибки и пользовательские уведомления.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.5.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/notification_events/
GET/notification_events/count
GET/notification_events/error_codes
GET/notification_events/types
GET/notification_events/user_defined_notifications/
GET/notification_events/user_defined_notifications/{uuid}
GET/notification_events/{uuid}
POST/notification_events/user_defined/
POST/notification_events/user_defined_notifications/
PUT/notification_events/user_defined/{uuid}
PUT/notification_events/user_defined_notifications/{uuid}
DELETE/notification_events/user_defined/{uuid}
DELETE/notification_events/user_defined_notifications/{uuid}

GET /notification_events/​

Раздел: Оповещения.

Возвращает постраничный список событий оповещений.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/"
  }
}

GET /notification_events/count​

Раздел: Оповещения.

Возвращает количество событий оповещения в системе за определенный период.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/count" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/count" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "count": 12
}

GET /notification_events/error_codes​

Раздел: Оповещения.

Возвращает список кодов ошибок событий оповещения с описанием.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/error_codes" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/error_codes" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/error_codes"
  }
}

GET /notification_events/types​

Раздел: Оповещения.

Возвращает список доступных типов событий оповещений с описанием.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/types" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/types" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/types"
  }
}

GET /notification_events/user_defined_notifications/​

Раздел: Оповещения.

Получает список пользовательских событий оповещения.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/user_defined_notifications/"
  }
}

GET /notification_events/user_defined_notifications/{uuid}​

Раздел: Оповещения.

Возвращает данные конкретного пользовательского события оповещения по uuid.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/user_defined_notifications/{uuid}"
  }
}

GET /notification_events/{uuid}​

Раздел: Оповещения.

Возвращает данные конкретного события оповещения по uuid.

Пример запроса​

curl -k -X GET "https://{IP_контроллера}/api/v1/notification_events/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/notification_events/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/notification_events/{uuid}"
  }
}

POST /notification_events/user_defined/​

Раздел: Оповещения.

Добавляет пользовательское событие с типом «Оповещения» (notification_events).

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/notification_events/user_defined/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}'

Пример тела запроса​

{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/notification_events/user_defined/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

POST /notification_events/user_defined_notifications/​

Раздел: Оповещения.

Добавляет пользовательскую настройку генерации событий оповещения и тревоги.

Пример запроса​

curl -k -X POST "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}'

Пример тела запроса​

{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /notification_events/user_defined/{uuid}​

Раздел: Оповещения.

Редактирует существующее пользовательское событие оповещений.

Пример запроса​

curl -k -X PUT "https://{IP_контроллера}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}'

Пример тела запроса​

{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /notification_events/user_defined_notifications/{uuid}​

Раздел: Оповещения.

Редактирует существующую пользовательскую настройку генерации события оповещения и тревоги.

Пример запроса​

curl -k -X PUT "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}'

Пример тела запроса​

{
  "type": "custom_notification",
  "message": "Внешнее уведомление"
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /notification_events/user_defined/{uuid}​

Раздел: Оповещения.

Удаляет пользовательское событие оповещений.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/notification_events/user_defined/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}

DELETE /notification_events/user_defined_notifications/{uuid}​

Раздел: Оповещения.

Удаляет пользовательскую настройку генерации события оповещения.

Пример запроса​

curl -k -X DELETE "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/notification_events/user_defined_notifications/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа​

{
  "status": "success",
  "deleted": true
}