Перейти к основному содержимому

Получить список ресурсов

Описание

Получить список ресурсов.

URL-адрес

Метод: POST

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

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

ПараметрТипПримерОбязательныйОписание
tokenstring"abcdefghijklmnqrstuvwxyz"ДаAPI токен
formatstring"json"НетФормат возвращаемых данных
(по умолчанию – "json")
from_idint1НетИдентификатор первого ресурса в списке
(по умолчанию – 1)
limitint1НетЛимит на количество возвращаемых ресурсов
(по умолчанию – 1000)
groups[]String[ "group1", "group2" ]НетСписок групп для поиска
(по умолчанию – [])
groups_id[]int[ 0, 1 ]НетСписок Id групп для поиска
(по умолчанию – [])

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

{
"from_id": 1,
"limit": 1,
"token": "abcdefghijklmnqrstuvwxyz"
}

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

{
"data": [
{
"id": 1,
"name": "Resource",
"groups": [
{
"id": 1,
"name": "subaccount"
}
]
}
],
"error": 0,
"error_text": "Successful operation",
"next_from_id": 4,
"total_count": 1
}

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

ПараметрТипОписание
errorintКод ошибки
error_textstringТекст ошибки
next_from_idintУказатель необходимо передать в следующем запросе для получения еще одной порции данных, до тех пор пока вывод результата не будет содержать 0 строчек истории
idintИдентификатор ресурса
namestringНазвание ресурса
total_countintОбщее количество ресурса
groups[]StringСписок групп