ClickHelp User Manual

[API] Create Topic

Creates a new topic in a project.

POST projects/{project-id}/articles

Authentication

This request requires basic authentication.

Request Parameters

Path params

project-id	string	The ID of the project to create topic in.

Body params

assigneeUserName	string	Topic assignee's login.
body	string	[optional] The HTML content of the topic.
id	string	The ID of the topic.
isShowInToc	bool	[optional] Whether the topic's TOC node is shown in the table of contents in publications. Sets the corresponding option in the topic's properties. false by default.
ownerUserName	string	Topic owner's login.
parentTocNodeId	string	[optional] The unique identifier of the parent TOC node. Specifying null will put the topic on the root level.
statusName	string	Topic's workflow status.
title	string	[optional] The topic title.
tocNodeCaption	string	[optional] Custom TOC node caption. If not specified, the topic title is used instead.
tocNodeOrdinalNo	int	[optional] The number indicating the position of the topic's TOC node in the table of contents. If not specified, will create the topic on the last position on the respective level.
indexKeywords	array of strings	[optional] An array of strings containing Index Keywords to set when creating a topic.

Samples

Request sample

Copy Code

Bash (Unix Shell)

curl --location -g --request POST 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles' ^
--data-raw '{
    "assigneeUserName":"admin",
    "body":"<p>This topic was created with the help of API<p>",
    "id":"nebula-api",
    "isShowInToc":true,
    "ownerUserName":"admin",
    "parentTocNodeId":null,
    "statusName":"draft",
    "title":"Nebula API",
    "tocNodeCaption":"",
    "tocNodeOrdinalNo":null,
  "indexKeywords": [
        "machinery",
        "api"
    ]
}'

[API] Get All Topics From Project/Publication [API] Update Topic