Изменить настройки контроля времени

PATCH /v1/workday/time-control/settings

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

Требуется скоуп timeman. Права проверяются у владельца учётных данных: для личного ключа это владелец ключа, для ключа приложения — пользователь, чей токен сессии передан в Authorization. Настройки меняет администратор портала, сотруднику без прав администратора приходит 403 BITRIX_ACCESS_DENIED. Приложению Битрикс24, от имени которого работает ключ приложения, достаточно права timeman. Ключ READONLY настройки не меняет. Текущие значения — Получить настройки контроля времени.

Поля запроса (body)

Все поля необязательные, но в теле должно быть хотя бы одно. Поля идут парами: reportRequestType и reportRequestUsers, reportSimpleType и reportSimpleUsers, reportFullType и reportFullUsers. Тип user передаётся вместе со своим списком в том же запросе, а список — только вместе с типом user.

Примеры

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

curl -X PATCH "https://vibecode.bitrix24.tech/v1/workday/time-control/settings" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reportSimpleType": "user", "reportSimpleUsers": [103, 107]}'

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

curl -X PATCH "https://vibecode.bitrix24.tech/v1/workday/time-control/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reportSimpleType": "user", "reportSimpleUsers": [103, 107]}'

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/settings', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ reportSimpleType: 'user', reportSimpleUsers: [103, 107] }),
})
const { data } = await res.json()

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/workday/time-control/settings', {
  method: 'PATCH',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ reportSimpleType: 'user', reportSimpleUsers: [103, 107] }),
})
const { data } = await res.json()

Поля ответа

Ответ — все настройки портала после записи, а не только изменённые поля. Подробное описание каждого поля — Получить настройки контроля времени.

ID, записанные этим методом, приходят числами. ID, сохранённые раньше другим способом, могут прийти строками, как reportRequestUsers в примере ниже. Сравнивайте ID после приведения к числу.

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

{
  "success": true,
  "data": {
    "active": false,
    "minimumIdleForReport": 15,
    "registerOffline": true,
    "registerIdle": true,
    "registerDesktop": true,
    "reportRequestType": "user",
    "reportRequestUsers": ["1"],
    "reportSimpleType": "user",
    "reportSimpleUsers": [103, 107],
    "reportFullType": "all",
    "reportFullUsers": []
  }
}

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

400 — список reportRequestUsers передан без reportRequestType: "user":

{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "reportRequestUsers requires the matching type user"
  }
}

Ошибки

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

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

• Тело проверяется целиком до записи: при ошибке в любом поле не меняется ни одна настройка, в том числе корректные поля из того же запроса.
• ID сотрудников в *Users не проверяются на существование: несуществующий ID сохраняется без ошибки.

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

• Получить настройки контроля времени
• Настройки контроля времени
• Получить месячный отчёт об отсутствиях
• Список сотрудников
• Рабочий день