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

Исключить сотрудника из графика

DELETE /v1/workday/schedules/:id/users/:userId

Исключает сотрудника из графика работы, в том числе из графика, назначенного всем сотрудникам, и снимает его будущие смены по этому графику. Вернуть сотрудника в график можно повторным включением.

Требуется скоуп timeman и право управлять графиками работы в Битрикс24: у администратора портала оно есть всегда, сотруднику его выдают в настройках прав доступа учёта рабочего времени. Ключ READONLY сотрудника из графика не исключает. Включить сотрудника в график — на странице Включить сотрудника в график.

Параметры

Параметр Тип Обяз. По умолч. Описание
id (path) integer да — ID графика работы, положительное целое. Где взять: страница «Рабочие графики» портала (/timeman/schedules/), списка графиков в API нет. Проверить по ID: GET /v1/workday/schedule
userId (path) integer да — ID сотрудника, положительное целое. Список: GET /v1/users

Примеры

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/workday/schedules/13/users/503" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl -X DELETE "https://vibecode.bitrix24.tech/v1/workday/schedules/13/users/503" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/schedules/13/users/503', {
  method: 'DELETE',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const { data } = await res.json()

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

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

Поля ответа

Поле Тип Описание
success boolean true, когда сотрудник исключён из графика
data.schedule object График, из которого исключён сотрудник
data.schedule.id integer ID графика
data.schedule.name string Название графика

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

JSON 
{
  "success": true,
  "data": {
    "schedule": {
      "id": 13,
      "name": "Офис 5/2"
    }
  }
}

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

404 — графика с таким id нет или он удалён:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Рабочий график не найден"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id или userId не положительное целое число
404 ENTITY_NOT_FOUND Графика с таким id нет, в том числе после удаления
422 BITRIX_ERROR У владельца учётных данных нет права управлять графиками работы, в message — «Недостаточно прав для управления рабочими графиками»
403 WRITE_BLOCKED_READONLY_KEY Ключ в режиме «только чтение»
409 TIMEMAN_MODULE_NOT_ENABLED Учёт рабочего времени недоступен на портале: инструмент «Рабочее время и отчёты» выключен в настройках портала или модуль не входит в тариф
502 BITRIX_UNAVAILABLE Битрикс24 недоступен или вернул ответ неожиданной формы
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Ключ приложения передан без токена сессии в Authorization: Bearer
401 INVALID_SESSION Токен сессии неверный или истёк
403 SCOPE_DENIED У ключа нет скоупа timeman
429 RATE_LIMITED Превышен общий лимит запросов, срок повтора — в заголовке Retry-After

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

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

Исключение не удаляет назначение графика. Сотрудник остаётся среди назначенных, но с отметкой об исключении, поэтому график для него не действует. POST /v1/workday/schedules/:id/users снимает отметку.

Другие графики сотрудника не меняются. Исключение действует только на график из id.

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