Получить информацию о шаблоне документа по Id crm.documentgenerator.template.get

Scope: crm

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

Метод crm.documentgenerator.template.get возвращает информацию о шаблоне по его идентификатору.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

Примеры кода

Как использовать примеры в документации

Пример получения шаблона документа, где:

  • идентификатор шаблона — 41
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":41}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.documentgenerator.template.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":41,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.documentgenerator.template.get
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.documentgenerator.template.get',
        		{
        			id: 41,
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.documentgenerator.template.get',
                    [
                        'id' => 41,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo '<pre>';
            print_r($result);
            echo '</pre>';
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting template: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.documentgenerator.template.get',
            {
                id: 41,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.documentgenerator.template.get',
            [
                'id' => 41,
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "template": {
                    "id": "41",
                    "name": "Шаблон из файла (обновлен)",
                    "region": "ru",
                    "code": null,
                    "download": "https://mysite.ru/bitrix/services/main/ajax.php?action=crm.documentgenerator.template.download&SITE_ID=s1&id=41",
                    "downloadMachine": "https://mysite.ru/rest/crm.documentgenerator.template.download.json?auth=***&token=***",
                    "active": "Y",
                    "moduleId": "crm",
                    "numeratorId": "49",
                    "withStamps": "N",
                    "users": {
                        "UA": "UA"
                    },
                    "isDeleted": "N",
                    "sort": "500",
                    "entityTypeId": [
                        "2"
                    ],
                    "createTime": "2026-03-18T15:54:20+03:00",
                    "updateTime": "2026-03-18T17:26:29+03:00"
                }
            },
            "time": {
                "start": 1773846100,
                "finish": 1773846100.102531,
                "duration": 0.10253095626831055,
                "processing": 0,
                "date_start": "2026-03-18T18:01:40+03:00",
                "date_finish": "2026-03-18T18:01:40+03:00",
                "operating_reset_at": 1773846700,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

Корневой элемент ответа. Содержит объект template

time
time

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

Тип template

Название
тип

Описание

id
string

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

name
string

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

region
string

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

code
string | null

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

download
string

Ссылка на скачивание файла шаблона

downloadMachine
string

Ссылка на скачивание файла шаблона для приложения

active
char

Активность шаблона: Y или N

moduleId
string

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

numeratorId
string

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

withStamps
char

Подставлять печать и подпись: Y или N

users
object

Объект кодов прав доступа в формате {"UA":"UA"}

isDeleted
char

Признак удаления шаблона: Y или N

sort
string

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

entityTypeId
array

Массив идентификаторов CRM-элементов, для которых доступен шаблон

createTime
datetime

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

updateTime
datetime

Дата и время последнего обновления шаблона

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Шаблон не найден"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

0

Шаблон не найден

Шаблон с указанным id не найден или недоступен

DOCGEN_ACCESS_ERROR

Access denied

Нет доступа к шаблону

Пустое значение

You do not have permissions to modify templates

Недостаточно прав для изменения шаблонов генератора документов

Пустое значение

Module documentgenerator is not installed

Модуль documentgenerator недоступен

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

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

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Изменить существующий шаблон документа
Следующая
Получить список шаблонов документов