Получить список ресурсов
Описание
Получить список ресурсов.
URL-адрес
Метод: POST
https://example.com/api/v1.1/resources/list
Параметры запроса
Параметр | Тип | Пример | Обязательный | Описание |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
format | string | "json" | Нет | Формат возвращаемых данных (по умолчанию – "json") |
from_id | int | 1 | Нет | Идентификатор первого ресурса в списке (по умолчанию – 1) |
limit | int | 1 | Нет | Лимит на количество возвращаемых ресурсов (по умолчанию – 1000) |
groups | []String | [ "group1", "group2" ] | Нет | Список групп для поиска (по умолчанию – [] ) |
groups_id | []int | [ 0, 1 ] | Нет | Список Id групп для поиска (по умолчанию – [] ) |
Пример запроса
- JSON
- XML
{
"from_id": 1,
"limit": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}
<xml>
<from_id>1</from_id>
<limit>1</limit>
<token>abcdefghijklmnqrstuvwxyz</token>
</xml>
Пример ответа
- JSON
- XML
{
"data": [
{
"id": 1,
"name": "Resource",
"groups": [
{
"id": 1,
"name": "subaccount"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 4,
"total_count": 1
}
<xml>
<data>
<id>1</id>
<name>Resource</name>
<groups>
<id>1</id>
<name>subaccount</name>
</groups>
</data>
<error>0</error>
<error_text>Successful operation</error_text>t>
<next_from_id>4</next_from_id>
<total_count>1</total_count>
</xml>
Возвращаемые параметры
Параметр | Тип | Описание |
---|---|---|
error | int | Код ошибки |
error_text | string | Текст ошибки |
next_from_id | int | Указатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории |
id | int | Идентификатор ресурса |
name | string | Название ресурса |
total_count | int | Общее количество ресурса |
groups | []String | Список групп |