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

---

Отправка одиночного события

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "TypeSystemName": "EventTypeSystemName",
        "TypeDisplayName": "EventTypeDisplayName",
        "TypeCode": "TypeCode",
        "Category": "ApplicationError",
        "Message": "Event message",
        "StartDate": "2016-04-30T23:25:43.511Z",
        "Count": 1,
        "Importance": "Alarm",
        "JoinKey": 45648117245,
        "JoinIntervalSeconds": 600,
        "Version": "1.0.0.0",
        "Properties": [
            {
                "Name": "Property1",
                "Value": "10.0",
                "Type": "double"
            },
            ...
        ]
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента, для которого отправляется событие.
• TypeSystemName (string) — Системное имя типа события. Если тип события с таким системным именем не найден, то он будет создан.
• TypeDisplayName (string) — Отображаемое имя типа события. Необязательное. Используется для создания типа события, если его не существует. Если не указано, то совпадает с системным именем.
• TypeCode (string) — Код типа события. Необязательный. Используется для создания типа события, если его не существует. Можно использовать для дополнительной идентификации ошибок.
• Category (string) — Категория события. Может иметь значения: ApplicationError, ComponentEvent. Используется для создания типа события, если его не существует.
• Message (string) — Текстовое описание события.
• StartDate (datetime) — Дата и время начала события. Необязательная. Если не указана, будет использовано текущее значение на стороне сервиса.
• Count (int) — Количество случившихся одинаковых событий за интервал от даты начала до даты окончания. Необязательное. Если не указано, то равно 1.
• Importance (string) — Важность события. Может иметь значения: Success, Warning, Alarm, Unknown. Необязательная. Если не указана, то для событий категории ApplicationError имеет значение Alarm, для всех остальных - Unknown. Итоговая важность может быть перекрыта настройками в личном кабинете.
• JoinKey (int64) — Ключ склейки. Необязательный. Если не указан, то для событий категории ApplicationError будет вычислен на стороне сервиса, для остальных будет равен 0.
• JoinIntervalSeconds (double) — Интервал склейки в секундах. Необязательный. Если не указан, то для событий категории ApplicationError будет равен 1 дню, для остальных будет равен 0. Итоговый интервал склейки может быть перекрыт настройками в личном кабинете.
• Version (string) — Версия компонента на момент отправки события. Необязательное. Если не указано, то берётся текущая версия компонента в сервисе. Используется, если события отправляются задним числом.
• Properties (array) — Массив дополнительных свойств события:
  • Name (string) — Название свойства.
  • Value — Значение свойства.
  • Type (string) — Тип свойства. Может быть одним из: Boolean, DateTime, Double, Int32, Int64, Binary, String, Guid.
  При наличии в событии стека рекомендуется записывать его в свойство с названием stack.

{
    "Data": {
        "EventId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "EventTypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Code": 10
}

Здесь:

• EventId (guid) — Уникальный Id события.
• EventTypeId (guid) — Уникальный Id типа события.

Если компонента с указанным Id не существует, то Code будет равен 1100, а Data будет пустым.