ClickHelp User Manual

Get Several TOC Nodes

Returns information on all TOC nodes from a project.

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

Authentication

This request requires basic authentication.

Request Parameters

Path params
project-id
string
The ID of the project to get a list of TOC nodes from.

Samples

Request sample
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/toc/nodes'
Response body sample
JSON
[
{
"caption": "",
"id": "0e7adad0-2572-4966-8f02-bc46930cf848",
"isShowInToc": true,
"ordinalNo": 1,
"parentId": null,
"topicId": "outer-space"
},
{
"caption": "",
"id": "928d32c6-579b-4e98-a79e-aae03f12f1b5",
"isShowInToc": true,
"ordinalNo": 2,
"parentId": null,
"topicId": "astronomical-objec"
}
]

Response fields

caption Custom TOC node caption as set in the topic properties. Empty if the topic title is used.
id The unique identifier of the TOC node.
isShowInToc
Whether the node is shown in the TOC in publications. Sets the corresponding option in the topic's properties.
ordinalNo
The number indicating the position of the node in the TOC.
parentId
The unique identifier of the parent TOC node. null if the node is on the root level.
topicId
The unique identifier of the topic associated with the TOC node.