documentgenerator.template.add

Scope: documentgenerator Права на выполнение: для всех

documentgenerator.template.add(fields)

Метод добавляет новый шаблон. Возвращает те же данные, что и при вызове documentgenerator.template.get() на новом шаблоне.

Контент файла (параметр file) можно передать двумя способами:

В POST-запросе закодированным в base64 (fields[file]);
Без кодировки в multipart/form-data (просто file);

Т.к. интерфейс должен быть реализован самостоятельно, то настройки видимости (параметр fields[users]) нужны только самому приложению. Аналогично индекс сортировки (параметр fields[sort]) и активность (параметр fields[active]).

Все созданные через этот метод шаблоны привязаны к модулю rest и единственному провайдеру \Bitrix\DocumentGenerator\DataProvider\Rest.

Параметры

Параметр Описание

fields

Параметр	Описание
fields	массив полей шаблона, среди которых: `fields[name]` - название шаблона (обязательное). `fields[file]` - контент файла, закодированный в base64 (обязательное). Как альтернативу, контент файла можно передать в multipart / form-data. В этом случае его не надо кодировать в base64. `fields[code]` - символьный код шаблона. `fields[numeratorId]` - идентификатор нумератора (обязательное). `fields[region]` - страна (обязательное). `fields[users]` - массив видимости. По умолчанию пусто. `fields[active]` - Y/N флаг активности. По умолчанию Y. `fields[withStamps]` - Y/N ставить печати и подписи. По умолчанию N `fields[sort]` - индекс сортировки.

массив полей шаблона, среди которых:

fields[name] - название шаблона (обязательное).
fields[file] - контент файла, закодированный в base64 (обязательное). Как альтернативу, контент файла можно передать в multipart / form-data. В этом случае его не надо кодировать в base64.
fields[code] - символьный код шаблона.
fields[numeratorId] - идентификатор нумератора (обязательное).
fields[region] - страна (обязательное).
fields[users] - массив видимости. По умолчанию пусто.
fields[active] - Y/N флаг активности. По умолчанию Y.
fields[withStamps] - Y/N ставить печати и подписи. По умолчанию N
fields[sort] - индекс сортировки.