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

Список расписаний

GET /v1/work-schedules

Возвращает библиотеку расписаний работы портала — готовые расписания платформы и свои — с числом серверов, назначенных на каждое.

Параметры

Параметров нет. Библиотека портала ограничена готовыми расписаниями платформы и 50 своими, поэтому фильтрация и пагинация не предусмотрены.

Примеры

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

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/work-schedules

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/work-schedules', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const own = data.filter(s => s.kind === 'CUSTOM')
console.log(`Расписаний: ${data.length}, своих: ${own.length}`)

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типarray ОписаниеРасписания портала: сначала готовые, затем свои в порядке создания
Полеdata[].id Типstring ОписаниеID расписания. Его принимают смена режима сервера и остальные операции библиотеки
Полеdata[].kind Типstring ОписаниеPRESET — готовое расписание платформы, CUSTOM — своё
Полеdata[].name Типstring ОписаниеНазвание. У готового расписания — на языке владельца ключа
Полеdata[].presetKey Типstring | null ОписаниеКлюч готового расписания: weekdays-9-18, weekdays-9-19, weekdays-9-20, weekdays-8-19, weekdays-8-20, daily-9-21. У своего — null
Полеdata[].timezone Типstring ОписаниеЧасовой пояс IANA, в котором читаются окна
Полеdata[].windows Типarray ОписаниеОкна { isoDay, start, end } в местном времени. Правила окон — в индексе раздела
Полеdata[].version Типnumber ОписаниеНомер версии. Передаётся в обновление
Полеdata[].canEdit Типboolean ОписаниеВправе ли владелец ключа править и удалять расписание. У готового всегда false
Полеdata[].assignedCount Типnumber ОписаниеСколько серверов портала работает по расписанию, включая серверы других сотрудников. Сами серверы не называются
Полеdata[].defaultForNewMachines Типboolean ОписаниеНа этом расписании рождаются новые серверы и приложения в галактике портала, если при создании режим не назван. true не больше чем у одного расписания. Отметку ставит администратор портала — Отметить расписание по умолчанию
Полеdata[].defaultForNewAgents Типboolean ОписаниеНа этом расписании рождаются новые агенты и боты портала. true не больше чем у одного расписания, отметка ставится отдельно от defaultForNewMachines

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": "cmfp4qz7x00031ocg5d1a8k2m",
      "kind": "PRESET",
      "name": "Будни 9–18",
      "presetKey": "weekdays-9-18",
      "timezone": "Europe/Moscow",
      "windows": [
        { "isoDay": 1, "start": "09:00", "end": "18:00" },
        { "isoDay": 2, "start": "09:00", "end": "18:00" },
        { "isoDay": 3, "start": "09:00", "end": "18:00" },
        { "isoDay": 4, "start": "09:00", "end": "18:00" },
        { "isoDay": 5, "start": "09:00", "end": "18:00" }
      ],
      "version": 1,
      "canEdit": false,
      "assignedCount": 3,
      "defaultForNewMachines": false,
      "defaultForNewAgents": false
    },
    {
      "id": "cmfp4r0q2000a1ocg7h2k9x3d",
      "kind": "CUSTOM",
      "name": "Смены склада",
      "presetKey": null,
      "timezone": "Europe/Moscow",
      "windows": [
        { "isoDay": 1, "start": "09:00", "end": "18:00" },
        { "isoDay": 2, "start": "09:00", "end": "13:00" },
        { "isoDay": 2, "start": "14:00", "end": "24:00" }
      ],
      "version": 2,
      "canEdit": true,
      "assignedCount": 1,
      "defaultForNewMachines": true,
      "defaultForNewAgents": false
    }
  ]
}

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

403 — у ключа нет скоупа vibe:infra:

JSON 
{
  "success": false,
  "error": {
    "code": "INFRA_SCOPE_REQUIRED",
    "message": "This API key does not have infrastructure rights (scope vibe:infra).",
    "details": { "requiredScope": "vibe:infra" }
  }
}

Ошибки

HTTP Код Описание
HTTP401 КодMISSING_API_KEY ОписаниеНе передан заголовок X-Api-Key
HTTP401 КодINVALID_API_KEY ОписаниеКлюч не опознан: такой строки на платформе нет
HTTP403 КодINFRA_SCOPE_REQUIRED ОписаниеУ ключа нет скоупа vibe:infra
HTTP403 КодINFRA_FORBIDDEN_FOR_COWORK_KEY ОписаниеВызов сделан ключом Cowork/Code. Библиотека расписаний управляет серверами и их счётом, поэтому такому ключу она закрыта целиком, включая чтение. Что делать — Проектный ключ для деплоя
HTTP404 КодNOT_FOUND ОписаниеКлюч не привязан к порталу Битрикс24
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит 60 запросов в минуту на ключ. Действующее значение — в заголовке x-ratelimit-limit

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

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

  • До включения режимов список пуст. Готовые расписания заводятся в библиотеке портала вместе с включением режимов работы, свои до этого создать нельзя. Пустой data у такого портала — не ошибка.
  • name у готового расписания зависит от ключа. Название не хранится в данных, а переводится на язык владельца ключа, поэтому два ключа одного портала могут получить разные строки. Опознавать готовое расписание надёжно по presetKey.

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