ClickHelp User Manual
[API] Get Topic
Returns information on a single topic.
GET projects/{id}/articles/{topic-id}
Authentication
This request requires basic authentication.
If the topic belongs to a public publication, authentication is not required.
Request Parameters
Path params
id | string |
The ID of the project or publication to get the specified topic from. |
---|---|---|
topic-id | string |
The ID of the topic to get information about. |
Samples
Request sample
Bash (Unix Shell) |
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles/nebula' |
Response body sample
JSON |
{ |
Response fields
assigneeUserName |
Topic assignee's login.
|
---|---|
body | The content of the <body> tag of the topic. Returns null for all methods except Get Topic. |
createdOn | An ISO 8601 timestamp of the topic creation date. GMT timezone. |
ftsSnippetHtml
|
The HTML markup of the topic title with a full-text search query matches highlighted. Populated only when isReturnSnippets is greater than zero. |
ftsTitleHtml
|
The HTML markup of a topic content snippet with a full-text search query matches highlighted. Populated only when isReturnSnippets is greater than zero. |
fullUrl
|
Full topic URL.
|
html
|
The HTML content of the topic. Returns null for all methods except Get Topic. |
id
|
The ID of the topic.
|
indexKeywords
|
An array of strings containing index keywords associated with the topic. Hierarchical keywords are represented as comma-separated values. |
modifiedOn
|
An ISO 8601 timestamp of the topic modification date. GMT timezone. |
ownerUserName
|
Topic owner's login.
|
projectId
|
The unique identifier of the project or publication. |
projectTitle
|
The title of the project or publication the topic belongs to.
|
projectUrl
|
[deprecated] Same as projectId.
|
smartLink
|
Smart link generated for the topic.
|
statusName
|
Topic's workflow status.
|
title
|
The topic title.
|
tocNodeId
|
The ID of the TOC node associated with the topic.
|
url
|
[deprecated] Same as id. |