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

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

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

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

Авторизация

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

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

Параметры пути

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

Образцы

Образец запроса

Copy Code

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'

Образец тела ответа

Copy Code

Bash (Unix Shell)

{
    "caption": "",
    "id": "0e7adad0-2572-4966-8f02-bc46930cf848",
    "isShowInToc": true,
    "ordinalNo": 1,
    "parentId": null,
    "topicId": "outer-space"
}

Поля ответа

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

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