метод REST scope: documentgenerator

documentgenerator.template.getfields

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

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

Описание

Метод documentgenerator.template.getfields возвращает карточку полей шаблона.

Параметры

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

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

Получить идентификатор шаблона можно после создания шаблона или методом получения списка шаблонов

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":57}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.getfields

Ответ

HTTP-статус: 200

{
    "result": {
        "templateFields": {
            "DocumentNumber": {
                "title": "Номер",
                "value": "9",
                "required": "Y",
                "group": [
                    "Документ"
                ],
                "chain": "this.DOCUMENT.DOCUMENT_NUMBER",
                "default": "9"
            },
            "CurrentDate": {
                "value": "",
                "default": ""
            },
            "ClientName": {
                "value": "",
                "default": ""
            },
            "ClientPhone": {
                "value": "",
                "default": ""
            },
            "Total": {
                "value": "",
                "default": ""
            },
            "Comment": {
                "value": "",
                "default": ""
            },
            "UserName": {
                "value": "",
                "default": ""
            },
            "DocumentTitle": {
                "title": "Название документа",
                "value": "SUPPLY_CONTRACT_NEW Template 1773843147554 9",
                "group": [
                    "Документ"
                ],
                "chain": [
                    {},
                    "getTitle"
                ],
                "required": "Y",
                "default": "SUPPLY_CONTRACT_NEW Template 1773843147554 9"
            }
        }
    },
    "time": {
        "start": 1774332782,
        "finish": 1774332783.055467,
        "duration": 1.055466890335083,
        "processing": 1,
        "date_start": "2026-03-24T09:13:02+03:00",
        "date_finish": "2026-03-24T09:13:03+03:00",
        "operating_reset_at": 1774333382,
        "operating": 0
    }
}

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

result object

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

time time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Cannot get fields from deleted template"
}
Код Описание Значение
400 100 Bitrix\DocumentGenerator\Template constructor must be is public
400 0 Шаблон не найден
400 0 Cannot get fields from deleted template
400 0 You do not have permissions to modify templates

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

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