метод REST scope: documentgenerator

documentgenerator.template.list

Получить список шаблонов

Кто может выполнять: пользователь с правом на изменение шаблонов генератора документов

Описание

Метод documentgenerator.template.list возвращает список шаблонов по фильтру.

Параметры

select array необязательный

Массив полей, которые нужно вернуть. По умолчанию — ["*"].

Для field_N используйте поля из таблицы полей.

Чтобы получить коды доступа и провайдеры, добавьте в select поля users и providers

order object необязательный

Объект для сортировки шаблонов в формате {"field_1":"value_1", ... "field_N":"value_N"}.

Направление сортировки может принимать значения:
- asc — по возрастанию
- desc — по убыванию

Для field_N используйте поля из таблицы полей.

filter object необязательный

Объект для фильтрации шаблонов в формате {"field_1":"value_1", ... "field_N":"value_N"}.

Для field_N используйте поля из таблицы полей.

К ключам field_n можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

По умолчанию применяется фильтр isDeleted = "N"

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N — 1) * 50, где N — номер нужной страницы

Поля для select, order, filter

id integer необязательный

Идентификатор шаблона

active char необязательный

Активность шаблона. Возможные значения:
- Y — активен
- N — не активен

name string необязательный

Название шаблона

code string необязательный

Символьный код шаблона

region string необязательный

Регион шаблона

sort integer необязательный

Индекс сортировки

createTime datetime необязательный

Дата и время создания

updateTime datetime необязательный

Дата и время обновления

numeratorId integer необязательный

Идентификатор нумератора

withStamps char необязательный

Использование печатей и подписей. Возможные значения:
- Y — да
- N — нет

users array необязательный

Коды доступа к шаблону. Только для select

providers array необязательный

Провайдеры данных шаблона. Только для select

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "select": [
      "*",
      "users",
      "providers"
    ],
    "order": {
      "id": "desc"
    },
    "filter": {
      "region": "ru",
      "active": "Y",
      ">=createTime": "2026-03-18T00:00:00+03:00"
    },
    "start": 0
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.list

Ответ

HTTP-статус: 200

{
    "result": {
        "templates": {
            "57": {
                "id": "57",
                "active": "Y",
                "name": "SUPPLY_CONTRACT_NEW Template",
                "code": "REST_TEMPLATE",
                "region": "ru",
                "sort": "700",
                "createTime": "2026-03-23T16:51:25+03:00",
                "updateTime": "2026-03-23T17:26:39+03:00",
                "createdBy": "503",
                "updatedBy": "503",
                "moduleId": "rest",
                "fileId": "5641",
                "bodyType": "Bitrix\\DocumentGenerator\\Body\\Docx",
                "numeratorId": "3",
                "withStamps": "N",
                "productsTableVariant": "",
                "isDeleted": "N",
                "isDefault": "N",
                "download": "/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57",
                "providers": [
                    "bitrix\\documentgenerator\\dataprovider\\rest"
                ],
                "users": [
                    "U503"
                ],
                "downloadMachine": "https://mysite.ru/rest/documentgenerator.api.template.download.json?auth=3f5cc2690000071b00000844000001f7f0f107506cefda4aa5b9d0dc80371e7f0f7e26&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3Jl89RFB3MHZYN1A3RXdiMm5EenY2VFYyc1Vkb0hPejA3SlM%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKbDg5UkZCM01IWllOMUEzUlhkaU1tNUVlblkyVkZZeWMxVmtiMGhQZWpBM1NsTT18M2Y1Y2MyNjkwMDAwMDcxYjAwMDAwODQ0MDAwMDAxZjdmMGYxMDc1MDZjZWZkYTRhYTViOWQwZGM4MDM3MWU3ZjBmN2UyNiI%3D.XuC83kQJE21vRoqv1%2FgdT8OiYq4JdpiSLxumy%2F1UcB0%3D"
            },
            "53": {
                "id": "53", // описание следующего шаблона
                ...
            },
            "51": {
                "id": "51", // описание следующего шаблона
                ...
            }
        }
    },
    "total": 3,
    "time": {
        "start": 1774341679,
        "finish": 1774341679.641056,
        "duration": 0.6410560607910156,
        "processing": 0,
        "date_start": "2026-03-24T11:41:19+03:00",
        "date_finish": "2026-03-24T11:41:19+03:00",
        "operating_reset_at": 1774342279,
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа (подробное описание)

total integer

Общее количество шаблонов в списке

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to modify templates"
}
Код Описание Значение
400 0 You do not have permissions to modify templates

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.