Документация для разработчиков
Темная тема

Особенности списочных методов и пакетного метода Batch

В REST существует ряд методов, которые возвращают списки элементов - списки сделок, пользователей, комментариев к задаче. Поскольку количество элементов, возвращаемых методами REST, зависит от конкретных условий и параметров, то Битрикс24 возвращает элементы «пакетами» по несколько элементов (в настоящий момент не более, чем по 50).

Пример:

https://my.bitrix24.ru/rest/methods.xml?auth=d161f25928c3184678924ec127edd29a
//получить список доступных методов в формате xml.

https://my.bitrix24.ru/rest/entity.item.get.json?ENTITY=menu&auth=d161f25928c3184678924ec127edd29a
//получить в формате json список всех элементов сущности menu.

При вызове списочных методов REST возвращает дополнительные значения в ответе:

Для получения следующего пакета элементов, необходимо выполнить тот же самый запрос, указав дополнительный параметр start со значением, пришедшем в параметре next ответа.

Пример:

{
	"result":результат выполнения метода,
	"error":ошибка выполнения метода,
	"total":общее количество записей в ответе списочного метода,
	"next":значение, которое нужно послать для получение следующей страницы данных списочного метода
}

Пример вывода следующего пакета элементов есть в описании метода crm.lead.list.

Исключение из этого - метод пакетного выполнения запросов batch, который возвращает ответ вида:

{
	"result":массив результатов запросов пакета,
	"result_error":массив ошибок запросов пакета,
	"result_total":массив количеств записей в ответах списочных методов,
	"result_next":массив значений, возвращенных в полях next запросов
}
© «Битрикс», 2001-2021, «1С-Битрикс», 2021
Наверх