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

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

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

Path Parameters
  • project-id
    string
    required

    Идентификатор проекта для обновления указанного элемента Дерева страниц.

  • node-id
    string
    required

    Идентификатор элемента Дерева страниц, который подлежит обновлению.

Body
application/json
caption
string
required

Обозначение элемента Дерева страниц.

isShowInToc
boolean
default:
false

Определяет, нужно ли отображать папку в Дереве страниц в публикациях. Устанавливает соответствующий параметр в свойствах страницы. Условие false (ложно) по умолчанию.

Exampletrue
ordinalNo
integer

Положение элемента в Дереве страниц. Если параметр не отправлен, элемент отобразится в конце.

Example2
parentId
string | nullable

Уникальный идентификатор родительского элемента Дерева страниц. При отправке null или отказе от отправки параметра элемент будет создан на корневом уровне.

updatedFields
string
required

Разделенный запятыми список полей, которые подлежат обновлению. Если имя поля отсутствует в списке, то оно не будет обновлено, даже если значение поля указано в других параметрах запроса.

ExampleparentId, caption, ordinalNo, isShowInToc
Responses
PATCH/projects/{project-id}/toc/nodes/{node-id}
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,
    "updatedFields":"parentId, caption, ordinalNo, isShowInToc"
}'


{
  "caption": "",
  "id": "0e7adad0-2572-4966-8f02-bc46930cf848",
  "isAutoDocsMountPoint": false,
  "isShowInToc": true,
  "ordinalNo": 2,
  "parentId": null,
  "topicId": "history-of-space-exploration",
  "topicTitle": "History of Space Exploration"
}

OK