Запросить демо
Запросить демо
Документерра: руководство пользователя

[API] Получение дочерних элементов Дерева страниц

Получение списка дочерних элементов Дерева страниц.

GET projects/{project-id}/toc/nodes/{toc-node-id}/children?isRecursive={is-recursive}  

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
project-id string
Идентификатор проекта, из которого нужно получить дочерние элементы.
toc-node-id string
Идентификатор элемента Дерева страниц, дочерние элементы которого необходимо получить. 
Параметры поискового запроса
isRecursive bool
[опционально] Определяет, нужно ли получать информацию и обо всех дочерних элементах. Условие false (ложно) по умолчанию.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes/0e7adad0-2572-4966-8f02-bc46930cf848/children?isRecursive=true'
Образец тела ответа
JSON
[
{
"caption": "",
"id": "69fc2771-20ef-496a-8141-b8fe38e0fac4",
"isShowInToc": true,
"ordinalNo": 0,
"parentId": "928d32c6-579b-4e98-a79e-aae03f12f1b5",
"topicId": "planetary-system"
},
{
"caption": "",
"id": "42914509-ee9b-4b95-9c25-0334419f86db",
"isShowInToc": true,
"ordinalNo": 1,
"parentId": "928d32c6-579b-4e98-a79e-aae03f12f1b5",
"topicId": "star-cluster"
}
]

Поля ответа

caption Пользовательское обозначение элемента Дерева страниц, заданное в свойствах страницы. Пусто, если используется заголовок страницы.
id Уникальный идентификатор элемента Дерева страниц.
isShowInToc
Показывает, отображается ли элемент в Дереве страниц в публикациях.   Определяет соответствующий параметр в свойствах страницы.
ordinalNo
Число, обозначающее положение элемента в Дереве страниц.
parentId
Уникальный идентификатор родительского элемента Дерева страниц. null, если элемент находится на корневом уровне.
topicId
Уникальный идентификатор страницы, связанный с элементом Дерева страниц.