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

Получить расписание

GET /v1/work-schedules/:id

Возвращает одно расписание работы из библиотеки портала: окна по дням недели, часовой пояс, версию и число назначенных серверов.

Параметры

Параметр В Тип Обяз. Описание
Параметрid Вpath Типstring Обяз.да ОписаниеID расписания. Источник — data[].id из списка расписаний или workSchedule.id в GET /v1/infra/servers/:id

Примеры

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

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

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

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

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

javascript 
const res = await fetch(
  `https://vibecode.bitrix24.tech/v1/work-schedules/${workScheduleId}`,
  { headers: { 'X-Api-Key': 'YOUR_API_KEY' } }
)
const { data } = await res.json()
console.log(`${data.name}: окон ${data.windows.length}, серверов ${data.assignedCount}`)

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Поле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 }: isoDay от 1 (понедельник) до 7, start и end — местное время ЧЧ:ММ, конец суток — 24:00
Полеdata.version Типnumber ОписаниеНомер версии. Передаётся в обновление
Полеdata.canEdit Типboolean ОписаниеВправе ли владелец ключа править и удалять расписание. У готового всегда false
Полеdata.assignedCount Типnumber ОписаниеСколько серверов портала работает по расписанию, включая серверы других сотрудников. Сами серверы не называются
Полеdata.defaultForNewMachines Типboolean ОписаниеНа этом расписании рождаются новые серверы и приложения в галактике портала, если при создании режим не назван. true не больше чем у одного расписания. Отметку ставит администратор портала — Отметить расписание по умолчанию
Полеdata.defaultForNewAgents Типboolean ОписаниеНа этом расписании рождаются новые агенты и боты портала. true не больше чем у одного расписания, отметка ставится отдельно от defaultForNewMachines

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

JSON 
{
  "success": true,
  "data": {
    "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
  }
}

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

404 — расписания нет в портале ключа:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Work schedule not found"
  }
}

Ошибки

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 ОписаниеРасписания с таким id нет в портале ключа, либо ключ не привязан к порталу Битрикс24. Расписание другого портала отвечает так же — ответ не подтверждает, что оно существует
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит 60 запросов в минуту на ключ. Действующее значение — в заголовке x-ratelimit-limit

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

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