Документация / API / Json / Компоненты / GetComponentTotalState

---

Получение итогового состояния компонента

Итоговое состояние — это внутреннее (собственное) состояние компонента плюс состояние всех его дочерних компонентов.

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "Recalc": false
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента.
• Recalc (bool) — Выполнять ли принудительный пересчёт состояния. Состояния кешируются сервисом и обновляются асинхронно. Если нужно получить точное состояние, используйте этот флаг.

{
    "Data": {
        "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "OwnerId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "StartDate": "2016-04-30T23:25:43.511Z",
        "EndDate": "2016-04-30T23:25:43.511Z",
        "ActualDate": "2016-04-30T23:25:43.511Z",
        "Status": "Success",
        "Message": "State text",
        "HasSignal": true,
        "DisableComment": "DisableComment",
        "DisableToDate": "2016-04-30T23:25:43.511Z"
    },
    "Code": 10
}

Здесь:

• Id (guid) — Уникальный Id состояния.
• OwnerId (guid) — Уникальный Id владельца состояния (в данном случае, совпадает с Id компонента).
• StartDate (datetime) — Дата и время начала состояния.
• EndDate (datetime) — Дата и время окончания состояния.
• ActualDate (datetime) — Дата и время актуальности состояния.
• Status (string) — Статус компонента. Может принимать значения: Success, Warning, Alarm, Disabled, Unknown.
• Message (string) — Текстовое описание статуса.
• HasSignal (bool) — Признак наличия сигнала. True означает, что состояние установлено явно по сигналу от приложения. False означает, что состояние установила система мониторинга из-за отсутствия сигнала от приложения.
• DisableComment (string) — Комментарий к последнему отключению компонента.
• DisableToDate (string) — Дата, до которой в последний раз отключался компонент.

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