Settings

GET

/api/settings

Получение списка настроек

Запрос

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

Name	In	Type	Description
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/settings

Ответ

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

{
   "_items": [
        {
            "_id": "0",
            "_updated": "Tue, 29 Sep 2020 09:55:41 GMT",
            "_created": "Fri, 25 Sep 2020 13:47:16 GMT",
            "addresses": {
                "resolver_address": "",
                "master_address": "config.dev",
                "file": "5f73049d836e90817cbccaab"
            },
            "_links": {
                "self": {
                    "title": "Setting",
                    "href": "settings/0"
                }
            }
        }
    ],
    "_links": {
        "parent": {
            "title": "home",
            "href": "/"
        },
        "self": {
            "title": "settings",
            "href": "settings"
        }
    },
    "_meta": {
        "page": 1,
        "max_results": 25,
        "total": 1
    }
}

GET

/api/settings/{id}

Получение настройки по id

Запрос

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

Name	In	Type	Description
projection (Optional)	url parameters	JSON object	Скрытие полей.
embedded (Optional)	url parameters	JSON object	Встраивание элементов в поля.

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

curl -X GET http://tkcontrol/api/settings/0

Ответ

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

{
    "_id": "0",
    "_updated": "Tue, 29 Sep 2020 09:55:41 GMT",
    "_created": "Fri, 25 Sep 2020 13:47:16 GMT",
    "addresses": {
    "resolver_address": "",
    "master_address": "config.dev",
    "file": "5f73049d836e90817cbccaab"
},
"_links": {
    "self": {
        "title": "Setting",
        "href": "settings/0"
    },
    "parent": {
        "title": "home",
        "href": "/"
        },
        "collection": {
            "title": "settings",
            "href": "settings"
        }
    }
}

PATCH

api/settings/{id}

Изменение настроек по id

Запрос

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

curl -X PATCH http://tkcontrol/api/settings/0 -H "Content-Type: application/json" -d '{ \
     { \
         "resolver_address": "10.10.19.156" \
     }'