Create TOC Node (Folder)

Create TOC Node (Folder)

Creates a folder in the table of contents of a project.

Path Parameters
  • project-id
    string
    required

    The ID of the project to create the folder in.

Body
application/json
caption
string
required

The folder name.

ExampleNew folder
isShowInToc
boolean
default:
false

Whether to show the folder in the TOC in publications. Sets the corresponding option in the topic's properties. false by default.

Exampletrue
ordinalNo
integer

The position of the node in the TOC. Not sending the parameter will place the node at the end.

parentId
string | nullable

The unique identifier of the parent TOC node. Sending null or not sending the parameter will create a node on the root level.

Example0e7adad0-2572-4966-8f02-bc46930cf848
Responses
POST/projects/{project-id}/toc/nodes
curl --location -g --request POST 'https://{portal-url}/api/v2/projects/project-deep-space-exploration/toc/nodes' \
--data-raw '{
    "caption": "New Folder",
    "isShowInToc": true,
    "ordinalNo": 0,
    "parentId": "0e7adad0-2572-4966-8f02-bc46930cf848"
}'


{
  "caption": "…",
  "id": "…",
  "isAutoDocsMountPoint": true,
  "isShowInToc": true,
  "ordinalNo": 1,
  "parentId": "…",
  "topicId": "…",
  "topicTitle": null
}

Created