Для AI-агентов: markdown этой страницы — /docs-content/entities/calendar-resources/fields.md индекс документации — /llms.txt

Поля ресурса календаря

GET /v1/calendar-resources/fields

Возвращает схему полей ресурса календаря — по ней проверяют, какие поля принимают создание и переименование.

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/calendar-resources/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/calendar-resources/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/calendar-resources/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.<поле>.type string Тип значения: number или string
data.fields.<поле>.readonly boolean true — поле только для чтения и в запросах записи не принимается
data.fields.<поле>.required boolean true — поле обязательно при создании. Приходит только у обязательных полей
data.fields.<поле>.label string Подпись поля
data.fields.<поле>.description string Описание поля
data.batch array Действия записи, которые принимает POST /v1/calendar-resources/batch: create

Поля ресурса в data.fields:

Поле Тип RO Описание
id number да ID ресурса
name string нет Название ресурса. Обязательно при создании и переименовании
createdBy number да ID сотрудника, создавшего ресурс. Список: GET /v1/users

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "number",
        "readonly": true,
        "label": "ID ресурса",
        "description": "ID ресурса."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Название ресурса",
        "description": "Название ресурса."
      },
      "createdBy": {
        "type": "number",
        "readonly": true,
        "label": "ID создателя",
        "description": "ID создателя."
      }
    },
    "batch": [
      "create"
    ]
  }
}

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

403 — нет скоупа:

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

Ошибки

HTTP Код Описание
403 SCOPE_DENIED API-ключ не имеет скоупа calendar
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов

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

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