## Поля рабочего места

`GET /v1/automated-solutions/fields`

Возвращает описание всех полей цифрового рабочего места с типом и признаком только для чтения. Поля без этого признака доступны для записи при создании и обновлении.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/automated-solutions/fields" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

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

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

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

Объект `data` содержит карту `fields` из трёх полей и список `batch` — операции, доступные этой сущности в пакетном вызове: `create`, `update`, `delete`. Каждое поле карты описано типом `type`, признаком только для чтения `readonly`, подписью `label` и описанием `description`. У обязательного при создании поля есть `required: true`, у массива — схема элемента `itemSchema`.

| Поле | Тип | RO | Описание |
|------|-----|:--:|---------|
| `id` | number | да | Идентификатор рабочего места. Назначается при создании |
| `title` | string | | Название рабочего места. Обязательно при создании |
| `typeIds` | array | | Идентификаторы привязанных типов смарт-процессов — поле `id` типа из [`GET /v1/smart-processes`](/docs/entities/smart-processes/list), а не его `entityTypeId`. Элементы — числа. В фильтре и сортировке списка не принимается |

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

```json
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID рабочего места",
        "description": "Идентификатор цифрового рабочего места. Назначается Битрикс24 при создании."
      },
      "title": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Название",
        "description": "Название цифрового рабочего места. Ссылка на раздел рабочего места на портале строится по названию, поэтому переименование меняет и ссылку."
      },
      "typeIds": {
        "type": "array",
        "readonly": false,
        "label": "Привязанные типы смарт-процессов",
        "description": "Идентификаторы типов смарт-процессов, привязанных к рабочему месту, — поле id типа из GET /v1/smart-processes, НЕ его entityTypeId. Это и есть путь записи для привязки смарт-процесса к цифровому рабочему месту. Тип состоит только в одном рабочем месте: привязка здесь снимает его с прежнего. На PATCH набор перезаписывается целиком: передавайте полный список либо не передавайте ключ вовсе. Неизвестное значение, в том числе entityTypeId, отбрасывается без ошибки, а раз набор перезаписывается целиком, это может отвязать все типы — сверяйте typeIds в ответе. В фильтре и сортировке не принимается — crm.automatedsolution.list фильтрует и сортирует только по id и title.",
        "itemSchema": {
          "type": "number"
        }
      }
    },
    "batch": ["create", "update", "delete"]
  }
}
```

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

401 — не передан API-ключ:

```json
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 401 | `MISSING_API_KEY` | Заголовок `X-Api-Key` не передан |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `crm` |
| 429 | `RATE_LIMITED` | Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке `x-ratelimit-limit` (потолок делится на реплики). Повторите после срока из заголовка `Retry-After` |

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

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

- [Создать рабочее место](/docs/entities/automated-solutions/create)
- [Обновить рабочее место](/docs/entities/automated-solutions/update)
- [Цифровые рабочие места](/docs/entities/automated-solutions)
- [Поля типа смарт-процесса](/docs/entities/smart-processes/fields)
- [Entity API](/docs/entity-api)