Получить список баз данных

Описание

Получить список баз данных.

URL-адрес

Метод: POST

https://example.com/api/v1.1/databases/list/

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

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
format	int	"json"	Нет	Формат возвращаемых данных по умолчанию – "json"
from_id	int	1	Нет	Идентификатор первой базы в списке по умолчанию – 1
limit	int	1	Нет	Лимит возвращаемых данных по умолчанию – 1000
ui_tags	[]String	[ "tag1", "tag2" ]	Нет	Список тегов для поиска по умолчанию – []
groups	[]String	[ "group1", "group2" ]	Нет	Список групп для поиска по умолчанию – []
groups_id	[]int	[ 0, 1 ]	Нет	Список Id групп для поиска по умолчанию – []

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

JSON

{
  "limit": 2,
  "token": "abcdefghijklmnqrstuvwxyz"
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <limit>2</limit>
  <token>abcdefghijklmnqrstuvwxyz</token>
</xml>

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

JSON

{
  "data": [
    {
      "id": 1,
      "name": "Database #1",
      "ui_tags": [],
      "Groups": [
        {
          "Id": 0,
          "Name": "main"
        }
      ]
    },
    {
      "id": 2,
      "name": "Database #2",
      "ui_tags": ["tag1", "tag2"],
      "Groups": [
        {
          "Id": 1,
          "Name": "subaccount"
        }
      ]
    }
  ],
  "error": 0,
  "error_text": "Successful operation",
  "next_from_id": 6,
  "total_count": 4
}

XML

<?xml version="1.0" encoding="UTF-8" ?>
<xml>
  <data>
    <id>1</id>
    <name>Database #1</name>
    <ui_tags/>
    <Groups>
      <Id>0</Id>
      <Name>main</Name>
    </Groups>
  </data>
  <data>
    <id>2</id>
    <name>Database #2</name>
    <ui_tags>tag1</ui_tags>
    <ui_tags>tag2</ui_tags>
    <Groups>
      <Id>1</Id>
      <Name>subaccount</Name>
    </Groups>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <next_from_id>6</next_from_id>
  <total_count>4</total_count>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
next_from_id	int	Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории
total_count	int	Общее количество баз данных
id	int	Идентификатор базы данных
name	string	Название базы данных
ui_tags	[]String	Список тегов
groups	[]String	Список групп