Документация / API / Json / События / JoinEvents

---

Отправка информации о продлении существующих событий

Если одинаковых событий случается много, то отправка каждого сообщения по одному становится неэффективной.
Приложение может склеивать события на своей стороне и кешировать эту информацию.
Для периодической отправки в сервис информации о продлении (склейке) уже существующих событий и предназначен этот метод.

АдресВашегоСервисаApi/JoinEvents

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": [
        {
            "EventId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "TypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "JoinKey": 45648117245,
            "StartDate": "2016-04-30T23:25:43.511Z",
            "JoinInterval": 600,
            "Importance": "Alarm",
            "Count": 1,
            "Message": "Event message",
            "Version": "1.0.0.0"
        }
    ]
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• EventId (guid) — Уникальный Id события, которое нужно продлить.
• ComponentId (guid) — Уникальный Id компонента, для которого отправляется событие.
• TypeId (guid) — Уникальный Id типа события.
• JoinKey (int64) — Ключ склейки. Необязательный. Если не указан, то для событий категории ApplicationError будет вычислен на стороне сервиса, для остальных будет равен 0.
• StartDate (datetime) — Дата и время начала события. Необязательная. Если не указана, будет использовано текущее значение на стороне сервиса.
• JoinInterval (double) — Интервал склейки в секундах. Необязательный. Если не указан, то для событий категории ApplicationError будет равен 1 дню, для остальных будет равен 0. Итоговый интервал склейки может быть перекрыт настройками в личном кабинете.
• Importance (string) — Важность события. Может иметь значения: Success, Warning, Alarm, Unknown. Необязательная. Если не указана, то для событий категории ApplicationError имеет значение Alarm, для всех остальных - Unknown. Итоговая важность может быть перекрыта настройками в личном кабинете.
• Count (int) — Количество случившихся одинаковых событий за интервал от даты начала до даты окончания. Необязательное. Если не указано, то равно 1.
• Message (string) — Текстовое описание события.
• Version (string) — Версия компонента на момент отправки события. Необязательное. Если не указано, то берётся текущая версия компонента в сервисе. Используется, если события отправляются задним числом.

{
    "Data": "",
    "Code": 10
}

В ответе возвращается только код результата.

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