Alerts

Scheme: alerts.

GET

/api/alerts

Получение списка уведомлений

Запрос

Параметры запроса:

Name	In	Type	Description
mark_as_read (Optional)	url parameters	integer	Если флаг установлен в 1, то заменяет поле 'read' на true.
where (Optional)	url parameters	JSON object	Фильтр элементов. Используется синтаксис mongo запросов.
sort (Optional)	url parameters	string	Сортировка элементов.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.
page (Optional)	url parameters	integer	Номер страницы элементов.
max_results (Optional)	url parameters	integer	Максимальное число элементов на одной странице.

Пример запроса:

curl -X GET http://tkcontrol/api/alerts

Ответ

Пример ответа:

{
    "_items": [
        {
            "_id": "5fbe0586114dbae05878a102",
            "type": "vnc.connect",
            "level": "info",
            "payload": {
                "hostname": "medpc-3b6547.localdomain",
                "status": "connected"
            },
            "read": true,
            "_updated": "Fri, 18 Dec 2020 08:11:41 GMT",
            "_created": "Wed, 25 Nov 2020 07:19:34 GMT",
            "_links": {
                "self": {
                    "title": "Alert",
                    "href": "alerts/5fbe0586114dbae05878a102"
                }
            }
        },
        {
            "_id": "5fbe04fd114dbae05878a0ff",
            "type": "vnc.connect",
            "level": "info",
            "payload": {
                "hostname": "medpc-3b6547.localdomain",
                "status": "connected"
            },
            "read": true,
            "_updated": "Fri, 18 Dec 2020 08:11:41 GMT",
            "_created": "Wed, 25 Nov 2020 07:17:17 GMT",
            "_links": {
                "self": {
                    "title": "Alert",
                    "href": "alerts/5fbe04fd114dbae05878a0ff"
                }
            }
        },
        {
            "_id": "5fb25e4f1e19e5a414df3533",
            "type": "vnc.connect",
            "level": "info",
            "payload": {
                "hostname": "medpc-3b6547.localdomain",
                "status": "connected"
            },
            "read": true,
            "_updated": "Fri, 18 Dec 2020 08:11:41 GMT",
            "_created": "Mon, 16 Nov 2020 11:11:11 GMT",
            "_links": {
                "self": {
                    "title": "Alert",
                    "href": "alerts/5fb25e4f1e19e5a414df3533"
                }
            }
        }
    ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
            "title": "alerts",
            "href": "alerts?max_results=3&sort=-_created&mark_as_read=1"
        },
        "next": {
            "title": "next page",
            "href": "alerts?max_results=3&sort=-_created&page=2&mark_as_read=1"
        },
        "last": {
            "title": "last page",
            "href": "alerts?max_results=3&sort=-_created&page=19&mark_as_read=1"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 3,
        "total": 56
    }
}

GET

/api/alerts/{id}

Получение уведомления по id

Запрос

Параметры запроса:

Name	In	Type	Description
mark_as_read (Optional)	url parameters	integer	Если флаг установлен в 1, то заменяет поле 'read' на true.
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

Пример запроса:

curl -X GET http://tkcontrol/api/alerts/5fb25e4f1e19e5a414df3533

Ответ

Пример ответа:

{
    "_id": "5fb25e4f1e19e5a414df3533",
    "type": "vnc.connect",
    "level": "info",
    "payload": {
        "hostname": "medpc-3b6547.localdomain",
        "status": "connected"
    },
    "read": true,
    "_updated": "Fri, 18 Dec 2020 08:11:55 GMT",
    "_created": "Mon, 16 Nov 2020 11:11:11 GMT",
    "_links": {
        "self": {
            "title": "Alert",
            "href": "alerts/5fb25e4f1e19e5a414df3533"
        },
        "parent": {
            "title": "home",
            "href": "/"
        },
        "collection": {
            "title": "alerts",
            "href": "alerts"
        }
    }
}