documentgenerator.document.list

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

documentgenerator.document.list(select = ['*'], order = [], filter = [], start = 0)

Возвращает список документов по фильтру.

Параметры

Параметр	Описание
select	массив полей для вывода.
order	массив для указания порядка вывода `{"id": "desc"}`.
filter	массив для фильтрации.
start	offset для постраничной навигации.

Пример фильтра

"filter": {
	"value": 5
}

В результате будет список документов, сформированный для внешнего идентификатора = 5.

Ответ

"documents": [
	"0": {
		"id": 1929, // id документа
		"title": "Rest Template 1", // название
		"number": "1", // номер
		"createTime": "2018-06-05T16:04:40+02:00", // дата создания
		"updateTime": "2018-06-05T16:04:40+02:00", // дата изменения
		"stampsEnabled": true // вставлены ли печати и подписи
		"downloadUrl": "", // ссылка на скачивание docx файла пользователем
		"downloadUrlMachine": "", // ссылка на скачивание docx файла приложением
		"imageUrl": "", // ссылка на скачивание картинки пользователем
		"imageUrlMachine": "", // ссылка на скачивание картинки приложением
		"pdfUrl": "", // ссылка на скачивание pdf пользователем
		"pdfUrlMachine": "", // ссылка на скачивание pdf приложением
		"publicUrl": "" // публичная ссылка (если есть)
		"isTransformationError": false, // была ли ошибка конвертации
		"templateId": "202", // ид шаблона
		"provider": "Bitrix\DocumentGenerator\DataProvider\Rest", // код провайдера
		"value": "1", // внешний идентификатор
		"values": { // значения полей
			"SomeDate": "2018-02-21T16:33:00+03:00",
		} 
	}
]