Работа со списками
Пагинация
При работе со списками сущностей API выводит информацию частями, по «страницам». Количество сущностей в ответе зависит от типа сущности, но общий интерфейс работает одинаково: для получения следующей страницы нужно передать GET-параметр after
, содержащий uuid
последней записи предыдущей страницы.
К примеру, навыки выводятся по 20:
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/skills | jq
{
"skills": [
..., // 19 навыков пропущено
{
"uuid": "3f5aa459-0a35-414f-9f13-42a044bab354",
"name": "Оптоволоконная сварка"
}
]
}
Для получения следующих навыков, передайте after
в строке запроса со значением uuid
последнего навыка в ответе:
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/skills?after=3f5aa459-0a35-414f-9f13-42a044bab354 | jq
{
"skills": [
... // следующие навыки
]
}
Чтобы получить все навыки, повторяйте последний шаг, прокручивая after
до тех пор, пока skills
не вернет пустой массив.
Одно и то же значение after
всегда возвращает одни и те же сущности в ответе (исключая удаленные).
Порядок элементов в ответе
Разные сущности упорядочены по-разному. В частности, значения, которые используются как справочные (навыки, участки, пользователи) сортируются от самых старых к самым новым.
Регулярно добавляемые сущности (наряды, клиенты и объекты) возвращаются в обратном порядке — от самых новых к самым старым.