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

[API] Создание элемента Дерева страниц (папки)

Создание папки в Дереве страниц проекта.

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

Авторизация

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

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

Параметры пути
project-id string
Идентификатор проекта, в котором будет создана папка.
Параметры тела запроса
captionstring
Имя папки.
isShowInTocbool
[опционально] Определяет, нужно ли отображать папку в Дереве страниц в публикациях.   Устанавливает соответствующий параметр в свойствах страницы. Условие false (ложно) по умолчанию.
ordinalNo
int
[опционально] Положение элемента в Дереве страниц. Если параметр не отправлен, элемент отобразится в конце.
parentId
string
[опционально] Уникальный идентификатор родительского элемента Дерева страниц. При отправке null или отказе от отправки параметра элемент будет создан на корневом уровне.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request POST 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes' ^
--data-raw '{
"caption":"New folder",
"isShowInToc": true,
"ordinalNo": 0,
"parentId": "0e7adad0-2572-4966-8f02-bc46930cf848"
}'