Variables
Получает информацию обо всех переменных контекста. Ответ содержит информацию о переменных. Можно использовать дополнительный параметр, чтобы включить в ответ информацию о формате таблицы.
Запрос
GET /v1/contexts/{contextPath}/variables
Замените {contextPath}
на полный путь контекста.
Поля заголовка запроса
- Authorization — Токен аутентификации. Более подробно об аутентификации см. раздел Аутентификация.
Параметры запроса
- includeFormat — Необязательный параметр. Ответ включает информацию о формате таблицы. Эта информация предоставляется в поле tableFormat. Возможные значения:
true
,false
.
Тело ответа
Список переменных контекста. Каждая запись содержит информацию об одной переменной.
Поля тела ответа
- name — Имя переменной.
- group — Группа переменной.
- tableFormat — Информация о формате таблицы.
- defaultValue — Значение по умолчанию.
- readable — Если переменная читается. Возможные значения:
true
,false
. - writable — Если переменная записывается. Возможные значения:
true
,false
.
Пример запроса
Запрос:
GET https://localhost:8443/rest/v1/contexts/users.admin.models.example/variables?includeFormat=false
Пример тела ответа JSON:
[
{
"name": "granulator",
"group": "default",
"tableFormat": null,
"defaultValue": [],
"readable": true,
"writable": true
},
{
"name": "exampleTable",
"group": "custom",
"tableFormat": null,
"defaultValue": [],
"readable": true,
"writable": true
}
]