Alert — получение уведомлений о недоступности

Дата последней модификации страницы: 19.09.2024

Группа методов Alert внешнего программного интерфейса Менеджера сервиса предназначена для получения уведомлений о недоступности.

Сводка по методам

МетодНазначение
alert/createЗарегистрировать новое уведомление о недоступности. Доступен только полноправному пользователю.
alert/infoИнформация об уведомлении о недоступности
alert/listСписок уведомлений о недоступности

alert/create

Зарегистрировать новое уведомление о недоступности. Доступен только полноправному пользователю.

ПараметрТипОписаниеПример
Запрос
startДата и время в строке формата ISOНачало недоступности19.09.2024 19:52:21
completionДата и время в строке формата ISOЗавершение недоступности19.09.2024 20:22:21
name *Строка переменная (1024)Заголовок уведомления. Если не передан, будет заполнен автоматически по шаблонуТехнические работы
text *Строка неограниченной длиныТекст уведомления. Если не передан, будет заполнен автоматически по шаблонуПоддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок
scheduled *БулевоПлановая недоступностьtrue
level *Число (+10.0)Критичность7
objects *
Объекты недоступности. Доступны только полноправному пользователю["Структура"]
  - typeСтрока (перечисление)Тип объекта:
  • cluster (Кластер)
  • configuration (Конфигурация)
  • infobase (Информационная база)
infobase
  - idСтрока переменная (256)Код объекта1
start_notifications_sending *БулевоЗапустить рассылку уведомленийfalse
Ответ: id (1)
Нет параметров
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/alert/create
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "start": "2024-09-19T19:52:21",
  "completion": "2024-09-19T20:22:21",
  "name": "Технические работы",
  "text": "Поддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок",
  "scheduled": true,
  "level": 7,
  "objects": [
    {
      "type": "infobase",
      "id": "1"
    }
  ],
  "start_notifications_sending": false
}
Пример ответа  Развернуть 
{
  "id": 1,
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

alert/info

Информация об уведомлении о недоступности

ПараметрТипОписаниеПример
Запрос
idЧисло (+9.0)Номер уведомления1
Ответ: alert (1)
idЧисло (+9.0)Номер уведомления1
startДата и время в строке формата ISOНачало недоступности19.09.2024 19:52:21
completionДата и время в строке формата ISOЗавершение недоступности19.09.2024 20:22:21
name *Строка переменная (1024)Заголовок уведомленияТехнические работы
text *Строка неограниченной длиныТекст уведомленияПоддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок
scheduled *БулевоПлановая недоступностьtrue
level *Число (+10.0)Критичность7
objectsСписок (0..*)Объекты недоступности. Доступны только полноправному пользователю["Структура"]
  - typeСтрока (перечисление)Тип объекта:
  • cluster (Кластер)
  • configuration (Конфигурация)
  • infobase (Информационная база)
infobase
  - idСтрока переменная (256)Код объекта1
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/alert/info
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "id": 1,
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "alert": {
    "id": 1,
    "start": "2024-09-19T19:52:21",
    "completion": "2024-09-19T20:22:21",
    "name": "Технические работы",
    "text": "Поддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок",
    "scheduled": true,
    "level": 7,
    "objects": [
      {
        "type": "infobase",
        "id": "1"
      }
    ]
  },
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх

alert/list

Список уведомлений о недоступности

ПараметрТипОписаниеПример
Запрос
Ответ: alert (0..*)
idЧисло (+9.0)Номер уведомления1
startДата и время в строке формата ISOНачало недоступности19.09.2024 19:52:21
completionДата и время в строке формата ISOЗавершение недоступности19.09.2024 20:22:21
name *Строка переменная (1024)Заголовок уведомленияТехнические работы
text *Строка неограниченной длиныТекст уведомленияПоддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок
scheduled *БулевоПлановая недоступностьtrue
level *Число (+10.0)Критичность7
Пример запроса  Развернуть 
POST https://1cfresh.com/a/adm/hs/ext_api/execute/usr/alert/list
Authorization: Basic base64_encode(user:password) или Bearer access_token

{
  "auth": {
    "account": 1010
  }
}
Пример ответа  Развернуть 
{
  "alert": [
    {
      "id": 1,
      "start": "2024-09-19T19:52:21",
      "completion": "2024-09-19T20:22:21",
      "name": "Технические работы",
      "text": "Поддержка изменений законодательства; Новые функциональные возможности; Исправление выявленных ошибок",
      "scheduled": true,
      "level": 7
    }
  ],
  "general": {
    "response": 10200,
    "error": false,
    "message": "",
    "version": 28,
    "sm_version": "1.1.37.1",
    "sm_timezone": "Europe/Moscow"
  }
}

Вверх