#Заменить состав

POST /v1/humanresources/nodes/:id/members/set

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

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор узла, состав которого заменяется

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

Поле Тип Обяз. Описание
userIds object да Новый состав узла. Ключ — роль, значение — массив идентификаторов сотрудников этой роли. Доступные роли — Участники узлов. Идентификаторы сотрудников: POST /v1/humanresources/employees/search

#Примеры

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

Terminal 
curl -X POST -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userIds": {"MEMBER_HEAD": [42], "MEMBER_EMPLOYEE": [108, 256]}}' \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/set

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

Terminal 
curl -X POST -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userIds": {"MEMBER_HEAD": [42], "MEMBER_EMPLOYEE": [108, 256]}}' \
  https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/set

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/set',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      userIds: { MEMBER_HEAD: [42], MEMBER_EMPLOYEE: [108, 256] },
    }),
  }
)
const body = await res.json()

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

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/humanresources/nodes/23/members/set',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      userIds: { MEMBER_HEAD: [42], MEMBER_EMPLOYEE: [108, 256] },
    }),
  }
)
const body = await res.json()

#Поля ответа

Поле Тип Описание
success boolean true при успешном выполнении
data.success boolean true, если состав узла заменён

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

JSON 
{
  "success": true,
  "data": {
    "success": true
  }
}

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

404 — неизвестная операция в пути:

JSON 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Unknown member verb: frobnicate. Allowed: move, remove, add, set"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS :id не является положительным целым числом либо нарушена структура тела запроса
404 NOT_FOUND Неизвестная операция в пути после members
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

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

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

  • Запрос задаёт весь состав узла целиком. В отличие от Добавить участников и Переместить участников, которые меняют отдельные роли, эта операция заменяет состав узла на тот, что передан в userIds. Сотрудники, отсутствующие в запросе, в узле не остаются.
  • userIds — объект, сгруппированный по ролям. Здесь userIds — объект, где ключ задаёт роль, а значение — массив идентификаторов сотрудников этой роли. В операциях add, remove и move userIds — это массив идентификаторов с отдельным полем role.

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