Получить информацию о запросе для шаблонов
Описание
Получить информацию о запросе для шаблонов.
URL-адрес
Метод: POST
https://example.com/api/v1.1/datatables/query_templates/get
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
id | int | 1 | Да, если не указан shortname | ID запроса |
shortname | string | "query1" | Да, если не указан id | Короткое название запроса |
Пример запроса
- JSON
- XML
{
"id": 2,
"token": "abcdefghijklmnqrstuvwxyz"
}
<xml>
<id>2</id>
<token>abcdefghijklmnqrstuvwxyz</token>
</xml>
Пример ответа
- JSON
- XML
{
"data": {
"id": 2,
"name": "QueryforextDB",
"shortname": "query",
"description": "External DB segment",
"sql": "SELECT * FROM table",
"connector_id": 1
},
"error": 0,
"error_text": "Successful operation",
}
<xml>
<data>
<connector_id>1</connector_id>
<description>External DB segment</description>
<id>2</id>
<name>QueryforextDB</name>
<shortname>query</shortname>
<sql>SELECT * FROM table</sql>
</data>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
id | int | ID запроса |
name | string | Название запроса |
shortname | string | Короткое название запроса |
description | string | Описание запроса |
connector_id | int | ID коннектора к внешней ДБ |
sql | string | SQL-запрос |
groups_id | []int | Список ID групп для поиска по умолчанию – [] |