метод REST scope: documentgenerator

documentgenerator.region.add

Добавить регион

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

Описание

Метод documentgenerator.region.add добавляет новый пользовательский регион.

Параметры

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

Параметры региона (подробное описание)

Параметр fields

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

Название региона

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

Идентификатор языка региона, например, ru

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

Формат даты

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

Формат даты и времени

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

Шаблон полного имени, например, #LAST_NAME# #NAME# #SECOND_NAME#.

Список возможных модификаторов:

  • #TITLE# — обращение
  • #NAME# — имя
  • #LAST_NAME# — фамилия
  • #SECOND_NAME# — отчество
  • #NAME_SHORT# — первая буква имени с точкой
  • #LAST_NAME_SHORT# — первая буква фамилии с точкой
  • #SECOND_NAME_SHORT# — первая буква отчества с точкой

Пользовательская документация

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

Набор локализованных фраз региона в формате код: текст.

Ключи объекта строковые и задаются произвольно в зависимости от шаблона. Значения ключей тоже строковые.

Чтобы понять, какие поля используются в шаблоне документа, получите их список методом documentgenerator.template.getfields. По этим полям удобно определить, для каких значений шаблона нужны свои языковые фразы.

Примеры:

  • TAX_INCLUDED: НДС включен в цену
  • TAX_NOT_INCLUDED: НДС не включен в цену

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "fields": {
      "title": "Россия (Пользовательский)",
      "languageId": "ru",
      "formatDate": "DD.MM.YYYY",
      "formatDatetime": "DD.MM.YYYY HH:MI:SS",
      "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
      "phrases": {
        "TAX_INCLUDED": "НДС включен в цену",
        "TAX_NOT_INCLUDED": "НДС не включен в цену"
      }
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.region.add

Ответ

HTTP-статус: 200

{
    "result": {
        "region": {
            "id": "1",
            "title": "Россия (Пользовательский)",
            "languageId": "ru",
            "formatDate": "DD.MM.YYYY",
            "formatDatetime": "DD.MM.YYYY HH:MI:SS",
            "formatName": "#LAST_NAME# #NAME# #SECOND_NAME#",
            "phrases": {
                "TAX_INCLUDED": "НДС включен в цену",
                "TAX_NOT_INCLUDED": "НДС не включен в цену"
            }
        }
    },
    "time": {
        "start": 1774431594,
        "finish": 1774431594.911013,
        "duration": 0.9110128879547119,
        "processing": 0,
        "date_start": "2026-03-25T12:39:54+03:00",
        "date_finish": "2026-03-25T12:39:54+03:00",
        "operating_reset_at": 1774432194,
        "operating": 0.23056697845458984
    }
}

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

result object

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

time time

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

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

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {fields}"
}
Код Описание Значение
400 100 Could not find value for parameter {fields}
400 BX_EMPTY_REQUIRED Не заполнено обязательное поле "TITLE"
400 0 You do not have permissions to modify templates

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

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