метод REST
scope: crm
crm.documentgenerator.template.get
Получить информацию о шаблоне документа по Id
Описание
Метод crm.documentgenerator.template.get возвращает информацию о шаблоне по его идентификатору.
Параметры
id
integer
необязательный
Идентификатор шаблона
Примеры запроса
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type TemplateGetResult = {
template: {
id: string
name: string
region: string
code: string | null
download: string
downloadMachine: string
active: string
moduleId: string
numeratorId: string
withStamps: string
users: Record<string, string>
isDeleted: string
sort: string
entityTypeId: string[]
createTime: ISODate
updateTime: ISODate
}
}
try {
const response = await $b24.actions.v2.call.make<TemplateGetResult>({
method: 'crm.documentgenerator.template.get',
params: {
id: 41,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result.template.id, result.template.name, result.template.active)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getTemplate() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.documentgenerator.template.get',
params: {
id: 41,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result.template.id, result.template.name, result.template.active)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTemplate)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.documentgenerator.template.get(bitrix_id=41).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.documentgenerator.template.get", b24.Params{
"id": 41,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.documentgenerator.template.get: %w", err)
}
// Метод заворачивает ответ в объект с ключом "template".
raw, ok := b24.Unwrap(res.Result, "template")
if !ok {
return fmt.Errorf("в ответе нет ключа template")
}
var item struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Region string `json:"region"`
Download string `json:"download"`
DownloadMachine string `json:"downloadMachine"`
Active string `json:"active"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)
Ответ
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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Шаблон не найден"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Шаблон не найден | Шаблон с указанным id не найден или недоступен |
DOCGEN_ACCESS_ERROR |
Access denied | Нет доступа к шаблону |
| — | You do not have permissions to modify templates | Недостаточно прав для изменения шаблонов генератора документов |
| — | Module documentgenerator is not installed | Модуль documentgenerator недоступен |

