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

`GET /v1/bizproc-templates/fields`

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

## Примеры

Читать схему можно только ключом авторизации — оба примера отправляют ключ авторизации и заголовок `Authorization: Bearer`. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — [Передача ключа](/docs/keys-auth#передача-ключа).

### curl — ключ авторизации

```bash
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-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/bizproc-templates/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
console.log(Object.keys(data.fields))
```

## Поля ответа

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.fields` | object | Схема полей: ключ — имя поля, значение — его описание |
| `data.fields.<поле>.type` | string | Тип значения: `number`, `string`, `array`, `datetime`, `boolean` |
| `data.fields.<поле>.readonly` | boolean | `true` — поле заполняется системой и в запросах на запись не передаётся |
| `data.fields.<поле>.required` | boolean | Приходит только у обязательных на создание полей |
| `data.batch` | array | Операции сущности, доступные в [`POST /v1/batch`](/docs/batch) |

Состав схемы:

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | RO | Идентификатор шаблона |
| `moduleId` | string | | Модуль, к которому привязан шаблон: `lists`, `crm`, `disk`, `bizproc` |
| `entity` | string | | Объект документа внутри модуля, например `BizprocDocument` |
| `documentType` | array | | Тип документа из трёх элементов — модуль, объект, тип |
| `templateData` | array | | Файл шаблона — имя файла и содержимое в base64. Обязателен на создание, в ответах чтения не возвращается |
| `autoExecute` | number | | Условие автозапуска: `0` — без автозапуска, `1` — при создании документа, `2` — при изменении, `3` — при создании и изменении |
| `name` | string | | Название шаблона |
| `description` | string | | Описание шаблона |
| `modified` | datetime | RO | Дата последнего изменения |
| `isModified` | boolean | RO | Правился ли шаблон после загрузки файла |
| `userId` | number | | Автор последнего изменения. Список: `GET /v1/users` |

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "moduleId": { "type": "string", "readonly": false },
      "entity": { "type": "string", "readonly": false },
      "documentType": { "type": "array", "readonly": false },
      "templateData": { "type": "array", "readonly": false, "required": true },
      "autoExecute": { "type": "number", "readonly": false },
      "name": { "type": "string", "readonly": false },
      "description": { "type": "string", "readonly": false },
      "modified": { "type": "datetime", "readonly": true },
      "isModified": { "type": "boolean", "readonly": true },
      "userId": { "type": "number", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

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

403 — запрос отправлен API-ключом:

```json
{
  "success": false,
  "error": {
    "code": "OAUTH_REQUIRED",
    "message": "bizproc-templates require an OAuth app key (vibe_app_*) with an Authorization: Bearer session — a personal vibe_api_* key lacks the per-user OAuth context Bitrix24 needs for these methods. Create an OAuth app (POST /v1/apps) and retry with its key. On this 403 switch keys — do NOT delete or recreate the app (that discards anything already registered under it, e.g. a bizproc robot you just registered)."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 403 | `OAUTH_REQUIRED` | Запрос отправлен API-ключом. Схема доступна только ключу авторизации |
| 401 | `TOKEN_MISSING` | Ключ авторизации без заголовка `Authorization: Bearer` |
| 401 | `WRONG_AUTH_SCHEME` | Ключ авторизации отправлен в заголовке `Authorization: Bearer`. Сам ключ передаётся в `X-Api-Key`, а `Authorization: Bearer` несёт токен сессии |
| 401 | `INVALID_SESSION` | Токен сессии истёк или недействителен — пройдите авторизацию заново |
| 403 | `SCOPE_DENIED` | Ключу не хватает скоупа `bizproc` |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

**Метка `readonly: false` не означает, что поле можно изменить.** Обновление применяет только `name`, `description`, `autoExecute` и `templateData` — см. [Обновить шаблон](./update.md). Остальные поля без метки `readonly` — `moduleId`, `entity`, `documentType`, `userId` — задаются при загрузке файла, и запрос на их изменение вернёт `200` без эффекта.

**Отсутствие метки `readonly` не означает, что поле можно прочитать.** У `templateData` стоит `readonly: false`, но обратно это поле не приходит ни в списке, ни через `select` — оно доступно только на запись.

**Метка `required: true` стоит только у `templateData`, хотя при загрузке обязательны три поля.** Схема отражает проверку на стороне Вайбкод: без `templateData` запрос отклоняется сразу с кодом `MISSING_REQUIRED_FIELDS`. Отсутствие `name` или `documentType` проходит эту проверку и отклоняется на шаг позже, с кодом `BITRIX_ERROR`. Полный список обязательных полей загрузки — на странице [Загрузить шаблон](./create.md).

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

- [Список шаблонов](/docs/entities/bizproc-templates/list)
- [Поиск шаблонов](/docs/entities/bizproc-templates/search)
- [Загрузить шаблон](/docs/entities/bizproc-templates/create)
- [Обновить шаблон](/docs/entities/bizproc-templates/update)
- [Удалить шаблон](/docs/entities/bizproc-templates/delete)
- [Ключи и авторизация](/docs/keys-auth)