#Дочерние узлы

GET /v1/humanresources/nodes/:id/children

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

#Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор родительского узла. Список узлов: GET /v1/humanresources/nodes?type=DEPARTMENT

#Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/17/children" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/humanresources/nodes/17/children" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/17/children', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(`Дочерних узлов: ${data.items.length}`)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/humanresources/nodes/17/children', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.items array Массив дочерних узлов
data.items[].id number Идентификатор узла
data.items[].name string Название узла
data.items[].type string Тип узла: DEPARTMENT или TEAM
data.items[].structureId number Идентификатор структуры, к которой относится узел
data.items[].parentId number Идентификатор родительского узла — совпадает с :id в запросе
data.items[].description string | null Описание узла. null, если описание не задано
data.items[].accessCode string Код доступа узла (например, D185 для отдела, SN23 для команды)
data.items[].userCount number Число сотрудников в узле
data.items[].colorName string | null Название цвета узла. null, если цвет не задан
data.items[].xmlId string | null Внешний идентификатор узла. null, если не задан
data.items[].createdAt string | null Дата создания (ISO 8601). null для узлов, созданных без отметки времени
data.items[].updatedAt string | null Дата последнего изменения (ISO 8601). null, если изменений не было

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

JSON 
{
  "success": true,
  "data": {
    "items": [
      {
        "id": 23,
        "name": "Отдел продаж",
        "type": "DEPARTMENT",
        "structureId": 1,
        "parentId": 17,
        "description": "Прямые продажи",
        "accessCode": "SN23",
        "userCount": 2,
        "colorName": null,
        "xmlId": null,
        "createdAt": null,
        "updatedAt": null
      }
    ]
  }
}

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

400 — :id не является положительным целым числом:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "id must be a positive integer"
  }
}

#Ошибки

HTTP Код Описание
400 INVALID_PARAMS :id не положительное целое число (0, отрицательное или нечисловое значение)
403 SCOPE_DENIED Ключу не хватает скоупа humanresources
401 TOKEN_MISSING У API-ключа не настроены токены Битрикс24

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

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

Массив узлов вложен под data.items. В отличие от списка узлов, где записи лежат в плоском data, дочерние узлы находятся под data.items.

Возвращаются только прямые потомки. Ответ содержит узлы ровно на один уровень ниже родителя. Чтобы построить полное поддерево, вызывайте эндпоинт рекурсивно для каждого узла из data.items, у которого есть свои потомки.

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