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

---

Получение событий по критериям

Метод возвращает список событий, соответствующих указанным критериям.
Незаполненные критерии не учитываются.
События сортируются по убыванию даты начала, максимум можно получить 1000 событий.

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "OwnerId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "From": "2016-04-30T23:25:43.511Z",
        "To": "2016-04-30T23:25:43.511Z",
        "Importance": [
            "Alarm", ...
        ],
        "TypeSystemName": "EventTypeSystemName",
        "SearchText": "Search text",
        "Category": "ApplicationError",
        "MaxCount": 1000
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• OwnerId (guid) — Уникальный Id владельца (например, компонента), для которого ищутся события.
• From (datetime) — Дата и время начала интервала поиска событий. Необязательная.
• To (datetime) — Дата и время окончания интервала поиска событий. Необязательная.
• Importance — Набор требуемых важностей событий. Необязательный. Элементы могут иметь значения: Success, Warning, Alarm, Unknown.
• TypeSystemName (string) — Системное имя типа событий. Необязательное. Ищется по полному совпадению.
• SearchText (string) — Текст события. Необязательный. Ищется по вхождению подстроки.
• Category (string) — Категория события. Необязательная. Может иметь значения: ApplicationError, ComponentEvent, ComponentUnitTestsStatus, ComponentEventsStatus, ComponentMetricsStatus, ComponentChildsStatus, ComponentInternalStatus, ComponentExternalStatus, UnitTestResult, UnitTestStatus, MetricStatus.
• MaxCount (int) — Максимальное количество событий в ответе. Необязательное. Не может быть больше 1000. Если не указано, будет равно 1000.

{
    "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.