Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Получить список документов documentgenerator.document.list», проанализируем лучшие практики и покажем, как правильно использовать documentgenerator.document.list в реальных задачах.
Получить список документов documentgenerator.document.list
Тут может не хватать некоторых данных — дополним в ближайшее время
- не указаны типы параметров
- не указана обязательность параметров
- отсутствует полный пример
- отсутствует ответ в случае ошибки
> Scope: documentgenerator
>
> Кто может выполнять метод: любой пользователь
Метод documentgenerator.document.list возвращает список документов по фильтру.
| Параметр | Описание |
|---|---|
| select | Массив полей для вывода. |
| order | Массив для указания порядка вывода {"id": "desc"}. |
| filter | Массив для фильтрации. |
| start | Порядковый номер элемента списка, начиная с которого необходимо возвращать следующие элементы при вызове текущего метода. Подробности в статье [](../../settings/how-to-call-rest-api/list-methods-pecularities) |
Пример фильтра
"filter": {
"value": 5
}В результате будет список документов, сформированный для внешнего идентификатора = 5.
Ответ в случае успеха
> 200 OK
"documents": [
{
"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"
}
}
]💡 Экспертное мнение и рекомендации
Практические рекомендации:
- При написании кастомных компонентов для «Получить список документов documentgenerator.document.list» всегда разделяйте бизнес-логику и представление (шаблон).
- Используйте отладку SQL-запросов через конструкцию
$wpdb->last_queryили стандартный трекер Битрикса, чтобы контролировать нагрузку.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru
