#Поля шаблона

GET /v1/doc-templates/fields

Возвращает полную схему полей шаблона документа: имя поля, тип, признак «только для чтения» и обязательность при создании. Поля помечены ★ — обязательны в теле запроса при создании шаблона.

#Примеры

#curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/doc-templates/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/doc-templates/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log('Всего полей:', Object.keys(data.fields).length)

#JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/doc-templates/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

#Поля ответа

Поле Bitrix24 Тип RO Описание
id id number да ID шаблона
name name string ★ Название шаблона
numeratorId numeratorId number ★ ID нумератора, который присваивает документам порядковые номера
region region string ★ Код региона шаблона, например ru или by
code code string Системный код шаблона для привязки в коде приложения
moduleId moduleId string Идентификатор модуля-владельца шаблона
active active string Доступность шаблона: Y — включён, N — выключен
bodyType bodyType string Формат тела документа, например DOCX
withStamps withStamps string Печать факсимиле и штампов: Y — добавляются, N — нет
sort sort number Порядок шаблона в списке: чем меньше значение, тем выше
users users array Идентификаторы сотрудников, которым доступен шаблон. Список: GET /v1/users
fileId fileId number ID файла на Диске; загрузка через POST /v1/files/upload
file file string Содержимое .docx в base64, принимается при создании
isDeleted isDeleted boolean да Шаблон помечен как удалённый
createTime createTime datetime да Дата создания
updateTime updateTime datetime да Дата изменения
provider provider string да Системный поставщик хранилища, в котором лежит файл шаблона
download download string да Ссылка для скачивания исходного файла шаблона
downloadMachine downloadMachine string да Ссылка для скачивания файла по машинному доступу без авторизации в браузере
providers providers object да Перечень доступных поставщиков хранилищ с их настройками

★ — поля name, numeratorId, region обязательны в теле запроса при создании шаблона.

#Пример ответа

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "name": { "type": "string", "readonly": false, "required": true },
      "numeratorId": { "type": "number", "readonly": false, "required": true },
      "region": { "type": "string", "readonly": false, "required": true },
      "code": { "type": "string", "readonly": false },
      "moduleId": { "type": "string", "readonly": false },
      "active": { "type": "string", "readonly": false },
      "bodyType": { "type": "string", "readonly": false },
      "withStamps": { "type": "string", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "users": { "type": "array", "readonly": false },
      "fileId": { "type": "number", "readonly": false },
      "file": { "type": "string", "readonly": false },
      "isDeleted": { "type": "boolean", "readonly": true },
      "createTime": { "type": "datetime", "readonly": true },
      "updateTime": { "type": "datetime", "readonly": true },
      "provider": { "type": "string", "readonly": true },
      "download": { "type": "string", "readonly": true },
      "downloadMachine": { "type": "string", "readonly": true },
      "providers": { "type": "object", "readonly": true }
    }
  }
}

#Пример ответа при ошибке

403 — у ключа нет нужного скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'documentgenerator' scope"
  }
}

#Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключу не хватает скоупа documentgenerator
401 TOKEN_MISSING у ключа нет настроенных токенов

Полный список общих ошибок API — Ошибки.

#Смотрите также