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

[API] Обновление элемента Дерева страниц

Обновление метаданных элементов Дерева страниц.

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

Авторизация

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

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

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

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

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

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

Образцы

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

Copy Code

Bash (Unix Shell)

curl --location -g --request PATCH 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes/0e7adad0-2572-4966-8f02-bc46930cf848' ^
--data-raw '{
    "caption":"",
    "isShowInToc":true,
    "ordinalNo":2,
    "parentId":null,
    "topicId":"22671c49-4a7a-4eec-94f1-aafb47d1f856",
    "updatedFields":"parentId, caption, ordinalNo, isShowInToc"
}'

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