## Поля рабочей группы `GET /v1/workgroups/fields` Возвращает схему полей рабочей группы и список операций, доступных в пакетных запросах. ## Примеры ### curl — личный ключ ```bash curl "https://vibecode.bitrix24.tech/v1/workgroups/fields" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### curl — OAuth-приложение ```bash curl "https://vibecode.bitrix24.tech/v1/workgroups/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/workgroups/fields', { headers: { 'X-Api-Key': 'YOUR_API_KEY', }, }) const { success, data } = await res.json() console.log('Полей:', Object.keys(data.fields).length) console.log('Доступные batch-операции:', data.batch) ``` ### JavaScript — OAuth-приложение ```javascript const res = await fetch('https://vibecode.bitrix24.tech/v1/workgroups/fields', { headers: { 'X-Api-Key': 'YOUR_APP_KEY', 'Authorization': 'Bearer USER_SESSION_TOKEN', }, }) const { success, data } = await res.json() ``` ## Поля ответа | Поле | Тип | Описание | |------|-----|---------| | `success` | boolean | Всегда `true` при успехе | | `data.fields` | object | Объект схемы полей рабочей группы | | `data.fields.<имя>` | object | Описание одного поля | | `data.fields.<имя>.type` | string | Тип значения: `number`, `string`, `boolean` или `datetime` | | `data.fields.<имя>.readonly` | boolean | Доступно ли поле для записи через `POST` / `PATCH` | | `data.batch` | array | Список операций сущности, доступных в [`POST /v1/batch`](/docs/batch): `create`, `update`, `delete` | ### Поля рабочей группы | Поле | Тип | Только чтение | Описание | |------|-----|:--:|---------| | `id` | number | да | Идентификатор рабочей группы | | `name` | string | | Название | | `description` | string | | Описание | | `active` | boolean | | Активна ли группа | | `visible` | boolean | | Видна ли в общих списках | | `opened` | boolean | | Открыта ли для вступления без приглашения | | `ownerId` | number | | Владелец (ответственный). Список: [`GET /v1/users`](/docs/entities/users) | | `subjectId` | number | | Идентификатор темы | | `subjectName` | string | да | Название темы | | `membersCount` | number | да | Количество участников | | `dateCreate` | datetime | да | Дата создания | | `dateUpdate` | datetime | да | Дата последнего обновления | | `dateActivity` | datetime | да | Дата последней активности | | `archived` | boolean | | Помещена ли в архив | | `isProject` | boolean | | Является ли проектом с задачами и сроками | | `isExtranet` | boolean | | Экстранет-группа | | `keywords` | string | | Ключевые слова | | `siteId` | string | да | Идентификатор сайта портала | | `imageUrl` | string | да | URL аватара группы | ## Пример ответа ```json { "success": true, "data": { "fields": { "id": { "type": "number", "readonly": true, "label": "ID", "description": "Идентификатор рабочей группы." }, "name": { "type": "string", "readonly": false, "label": "Название", "description": "Название рабочей группы." }, "description": { "type": "string", "readonly": false, "label": "Описание", "description": "Текстовое описание рабочей группы." }, "active": { "type": "boolean", "readonly": false, "label": "Активна", "description": "Признак того, что группа активна." }, "visible": { "type": "boolean", "readonly": false, "label": "Видна в списках", "description": "Признак того, что группа отображается в общих списках." }, "opened": { "type": "boolean", "readonly": false, "label": "Открытая группа", "description": "Признак того, что вступление в группу возможно без приглашения." }, "ownerId": { "type": "number", "readonly": false, "label": "Владелец", "description": "Идентификатор пользователя, ответственного за группу." }, "subjectId": { "type": "number", "readonly": false, "label": "ID темы", "description": "Идентификатор темы (направления деятельности) рабочей группы." }, "subjectName": { "type": "string", "readonly": true, "label": "Название темы", "description": "Название темы, к которой относится рабочая группа." }, "membersCount": { "type": "number", "readonly": true, "label": "Число участников", "description": "Число участников рабочей группы." }, "dateCreate": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата и время создания рабочей группы." }, "dateUpdate": { "type": "datetime", "readonly": true, "label": "Дата обновления", "description": "Дата и время последнего обновления рабочей группы." }, "dateActivity": { "type": "datetime", "readonly": true, "label": "Дата активности", "description": "Дата и время последней активности в рабочей группе." }, "archived": { "type": "boolean", "readonly": false, "label": "В архиве", "description": "Признак того, что группа помещена в архив." }, "isProject": { "type": "boolean", "readonly": false, "label": "Проект", "description": "Признак того, что группа является проектом с задачами и сроками." }, "isExtranet": { "type": "boolean", "readonly": false, "label": "Экстранет-группа", "description": "Признак того, что группа относится к экстранету." }, "keywords": { "type": "string", "readonly": false, "label": "Ключевые слова", "description": "Ключевые слова, связанные с рабочей группой." }, "siteId": { "type": "string", "readonly": true, "label": "ID сайта", "description": "Идентификатор сайта портала, к которому относится группа." }, "imageUrl": { "type": "string", "readonly": true, "label": "URL аватара", "description": "Ссылка на изображение аватара рабочей группы." } }, "batch": ["create", "update", "delete"] } } ``` ## Пример ответа при ошибке 401 — нет ключа авторизации: ```json { "success": false, "error": { "code": "MISSING_API_KEY", "message": "API key is required" } } ``` ## Ошибки | HTTP | Код | Описание | |------|-----|---------| | 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` | | 401 | `INVALID_API_KEY` | Передан неверный ключ | | 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `sonet_group` | Полный список общих ошибок API — [Ошибки](/docs/errors). ## Известные особенности - Список полей не зависит от прав пользователя ключа — возвращается полная схема сущности. - Кроме операций, перечисленных в `data.batch`, в [`POST /v1/batch`](/docs/batch) для рабочих групп можно вызывать `get`, `list` и `fields`. ## Смотрите также - [Список рабочих групп](./list.md) - [Создать рабочую группу](./create.md) - [Обновить рабочую группу](./update.md) - [Batch](/docs/batch) - [Entity API](/docs/entity-api)