catalog.document.list
Scope: catalog Права на выполнение: для всех
catalog.document.list(order, filter, select, offset, limit)
Метод для получения списка документов.
Если операция успешна, возвращается список документов в теле ответа.
Параметры
Параметр | Тип | Описание |
---|---|---|
order | array | Сортировка. |
filter | array | Фильтр. |
select | array | Список получаемых полей. |
offset | integer | Страница выборки, работает аналогично start. |
limit | integer | Размер страницы от 1 до 500 (если указан 0 или число больше максимального, то используется значение по умолчанию 50). |
start | string | Номер страницы вывода. Работает для https запросов. |
Примеры
Для JS
BX24.callMethod( 'catalog.document.list', { 'order': { 'id': 'asc', }, 'filter': { '>id': 0, }, 'offset': 0, 'limit': 50, }, function(result) { if(result.error()) console.error(result.error()); else console.log(result.data()); result.next(); } );
$result = CRest::call( 'catalog.document.list', [ 'order' => [ 'id' => 'asc', ], 'filter' => [ '>id' => 0, ], 'offset' => 0, 'limit' => 5, ] ); echo '<pre>'; print_r($result); echo '</pre>';
Для HTTPS
https://ваш_портал/rest/catalog.document.list?auth=_ключ_авторизации_&start=50
© «Битрикс», 2001-2024, «1С-Битрикс», 2024