При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список шаблонов documentgenerator.template.list», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.
Получить список шаблонов documentgenerator.template.list
Тут может не хватать некоторых данных — дополним в ближайшее время
- не указаны типы параметров
- не указана обязательность параметров
- отсутствуют примеры
- отсутствует ответ в случае ошибки
> Scope: documentgenerator
>
> Кто может выполнять метод: любой пользователь
Метод documentgenerator.template.list возвращает список шаблонов по фильтру.
| Параметр | Описание |
|---|---|
| select | Массив полей для вывода. По умолчанию выводит все поля шаблона, кроме users и providers. Чтобы они появились, надо добавить дополнительно. Например, ['*', 'providers', 'users']. |
| order | Массив для указания порядка вывода {"id": "desc"}. |
| filter | Массив для фильтрации. |
| start | Порядковый номер элемента списка, начиная с которого необходимо возвращать следующие элементы при вызове текущего метода. Подробности в статье [](../../../settings/how-to-call-rest-api/list-methods-pecularities) |
Практический пример и готовый код на PHP
templates: {
202: {
"id": "202",
"active": "Y",
"name": "Rest Template",
"code": "",
"region": "ru",
"sort": "100",
"createTime": "2018-06-05T13:07:12+02:00",
"updateTime": "2018-09-06T14:26:24+02:00",
"moduleId": "rest",
"numeratorId": "20",
"withStamps": "N",
"isDeleted": "N",
"download": "",
"downloadMachine": "",
"providers": [
"bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
],
"users": [
"0": "UA"
]
}
}Примеры фильтра
filter: {
"numeratorId": "20",
"region": "ru",
"active": "Y"
}По умолчанию фильтр имеет следующие значения:
filter: {
"moduleId": "rest", // изменить нельзя, метод всегда вернет шаблоны только для реста
"isDeleted": "N" // если нужен список шаблонов без учета isDeleted, необходимо передать "@isDeleted": ["Y", "N"]
}Ответ в случае успеха
Метод вернет список шаблонов с их полями.
💡 Экспертное мнение и рекомендации
Советы эксперта по интеграции:
- Всегда используйте кэширование при частых запросах к documentgenerator.template.list, чтобы разгрузить базу данных.
- Соблюдайте стандарты PSR при написании обработчиков для «Получить список шаблонов documentgenerator.template.list».
- Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru