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

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

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

GET projects/{project-id}/toc/nodes

Авторизация

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

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

Параметры пути
project-id
string
Идентификатор проекта, для которого нужно получить список элементов Дерева страниц.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes'
Образец тела ответа
JSON
[
{
"caption": "",
"id": "0e7adad0-2572-4966-8f02-bc46930cf848",
"isShowInToc": true,
"ordinalNo": 1,
"parentId": null,
"topicId": "outer-space"
},
{
"caption": "",
"id": "928d32c6-579b-4e98-a79e-aae03f12f1b5",
"isShowInToc": true,
"ordinalNo": 2,
"parentId": null,
"topicId": "astronomical-objec"
}
]

Поля ответа

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