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

catalog.document.list

Scope: catalog Права на выполнение: для всех

catalog.document.list(order, filter, select, offset, limit)

Метод для получения списка документов.

Если операция успешна, возвращается список документов в теле ответа.

Параметры

ПараметрТип Описание
orderarray Сортировка.
filterarray Фильтр.
selectarray Список получаемых полей.
offsetinteger Страница выборки, работает аналогично start.
limitinteger Размер страницы от 1 до 500 (если указан 0 или число больше максимального, то используется значение по умолчанию 50).
startstring Номер страницы вывода. Работает для 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

Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
1
Вагиз Абдулин
Сообщение не промодерировано, возможны ошибки и неточности.
Как получить список документов реализации?
Этот метод выводит все документы склада кроме реализации. Почему?
© «Битрикс», 2001-2024, «1С-Битрикс», 2024