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

---

Получение события по Id

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "EventId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• EventId (guid) — Уникальный Id события.

{
    "Data": {
        "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "OwnerId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "TypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "TypeSystemName": "EventTypeSystemName",
        "TypeDisplayName": "EventTypeDisplayName",
        "TypeCode": "TypeCode",
        "Category": "ApplicationError",
        "Message": "Event message",
        "StartDate": "2016-04-30T23:25:43.511Z",
        "EndDate": "2016-04-30T23:25:43.511Z",
        "Count": 1,
        "Importance": "Alarm",
        "JoinKeyHash": 45648117245,
        "Version": "1.0.0.0",
        "Properties": [
            {
                "Name": "Property1",
                "Value": "10.0",
                "Type": "double"
            },
            ...
        ]
    },
    "Code": 10
}

Здесь:

• Id (guid) — Уникальный Id события.
• OwnerId (guid) — Уникальный Id владельца события.
• TypeId (guid) — Уникальный Id типа события.
• TypeSystemName (string) — Системное имя типа события.
• TypeDisplayName (string) — Отображаемое имя типа события.
• TypeCode (string) — Код типа события.
• Category (string) — Категория события.
• Message (string) — Текстовое описание события.
• StartDate (datetime) — Дата начала события.
• EndDate (datetime) — Дата окончания события.
• Count (int) — Количество случившихся одинаковых событий за интервал от даты начала до даты окончания.
• Importance (string) — Важность события.
• JoinKeyHash (int64) — Ключ склейки события.
• Version (string) — Версия компонента на момент отправки события (может отличаться от текущей версии компонента).
• Properties (array) — Массив дополнительных свойств события:
  • Name (string) — Название свойства.
  • Value — Значение свойства.
  • Type (string) — Тип свойства. Может быть одним из: Boolean, DateTime, Double, Int32, Int64, Binary, String, Guid.

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