3.12.5.3.3. Дополнительные возможности
Получение справки по объектам/командам
Специальные команды позволяют получить информацию о поддерживаемых объектах/командах.
Все команды в случае успеха (объект/команда найдены) возвращают в теле ответа секцию с описанием:
{
"help": {
// Краткое описание
"brief": "SHORT_DESCRIPTION",
// Полное описание
"description": "DESCRIPTION"
}
}
|
Справка по поддерживаемым объектам
Запрос
// Получение информации о поддерживаемых объектах уровня Сервера
{ "help": "" }
// Получение справки о поддерживаемых объектах уровня базы данных db_name
{
"help": "",
"object": "db/db_name"
}
|
Не имеет параметров.
Результат
{
"result": {
// Массив описания поддерживаемых объектов
"objects": [
// Описание объекта
{
// Название объекта (для обращения к нему по этому имени)
"object": "OBJECT_NAME",
// Краткое описание объекта
"brief": "SHORT_DESCRIPTION"
},
...
]
}
}
|
Справка по поддерживаемым командам
Получение информации о командах, поддерживаемых объектом
{ "help": "", "object": "TARGET_OBJECT" }
|
Не имеет параметров.
Результат
{
"result": {
// Массив описания команд
"commands": [
// Описание команды
{
// Название команды (для обращения к ней по этому имени)
"command": "COMMAND_NAME",
// Краткое описание команды
"brief": "SHORT_DESCRIPTION"
},
...
]
}
}
|
Справка по команде
Получение информации о команде
{ "help": "", "object": "TARGET_OBJECT", "command": "OBJECT_COMMAND" }
|
Не имеет параметров. В ответе возвращается только блок описания.