ClickHelp User Manual

Get Topic

Returns information on a single topic.

GET projects/{project-id}/articles/{topic-id}

Authentication

This request requires basic authentication.

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
{
"assigneeUserName": "admin",
"createdOn": "2021-05-10T12:32:25",
"ftsSnippetHtml": null,
"ftsTitleHtml": null,
"fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration/nebula",
"html": "<!DOCTYPE html><html lang=\"en-US\"><head><style type=\"text/css\">.ArticleViewer_searchKeywords{background-color: yellow !important;}body{overflow:hidden;}</style>\r\n<script type=\"text/javascript\">//<!--\r\nvar articlesServiceUrl='/article/';\r\n//--></script>\r\n<link rel=\"canonical\" href=\"/articles/project-deep-space-exploration/nebula\"/>\r\n<title>Nebula</title><script type=\"text/javascript\">//<!--\r\nvar articleTitleText='Nebula';\r\n//--></script><link rel=\"stylesheet\" type=\"text/css\" href=\"/resources/Styles/project-deep-space-exploration/Style.css\"/><link rel=\"stylesheet\" type=\"text/css\" href=\"/style-bundles/article-published.css?v=1.0.8321.27119\"/><script src=\"/resources/Scripts/project-deep-space-exploration/Script.js\" type=\"text/javascript\"></script><script src=\"/script-bundles/article-published.js?v=1.0.8321.27119\" type=\"text/javascript\"></script><meta charset=\"utf-8\"><meta http-equiv=\"Content-Type\" content=\"text/html;charset=utf-8\"></head><body><span id=\"__clhTop\"></span><p>A&nbsp;nebula&nbsp;(<a href=\"https://en.wikipedia.org/wiki/Latin\" title=\"Latin\" target=\"_top\">Latin</a>&nbsp;for &#39;cloud&#39; or &#39;fog&#39;;<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-2\" target=\"_top\">[2]</a>&nbsp;pl.&nbsp;nebulae,&nbsp;nebulæ&nbsp;or&nbsp;nebulas<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-3\" target=\"_top\">[3]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-4\" target=\"_top\">[4]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-5\" target=\"_top\">[5]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-6\" target=\"_top\">[6]</a>) is an&nbsp;<a href=\"https://en.wikipedia.org/wiki/Interstellar_cloud\" title=\"Interstellar cloud\" target=\"_top\">interstellar cloud</a>&nbsp;of&nbsp;<a href=\"https://en.wikipedia.org/wiki/Cosmic_dust\" title=\"Cosmic dust\" target=\"_top\">dust</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Hydrogen\" title=\"Hydrogen\" target=\"_top\">hydrogen</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Helium\" title=\"Helium\" target=\"_top\">helium</a>&nbsp;and other&nbsp;<a href=\"https://en.wikipedia.org/wiki/Plasma_(physics)\" title=\"Plasma (physics)\" target=\"_top\">ionized gases</a>. Originally, the term was used to describe any diffused&nbsp;<a href=\"https://en.wikipedia.org/wiki/Astronomical_object\" title=\"Astronomical object\" target=\"_top\">astronomical object</a>, including&nbsp;<a href=\"https://en.wikipedia.org/wiki/Galaxy\" title=\"Galaxy\" target=\"_top\">galaxies</a>&nbsp;beyond the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Milky_Way\" title=\"Milky Way\" target=\"_top\">Milky Way</a>. The&nbsp;<a href=\"https://en.wikipedia.org/wiki/Andromeda_Galaxy\" title=\"Andromeda Galaxy\" target=\"_top\">Andromeda Galaxy</a>, for instance, was once referred to as the&nbsp;Andromeda Nebula&nbsp;(and&nbsp;<a href=\"https://en.wikipedia.org/wiki/Spiral_galaxies\" title=\"Spiral galaxies\" target=\"_top\">spiral galaxies</a>&nbsp;in general as &quot;spiral nebulae&quot;) before the true nature of galaxies was confirmed in the early 20th century by&nbsp;<a href=\"https://en.wikipedia.org/wiki/Vesto_Slipher\" title=\"Vesto Slipher\" target=\"_top\">Vesto Slipher</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Edwin_Hubble\" title=\"Edwin Hubble\" target=\"_top\">Edwin Hubble</a>&nbsp;and others.</p><p>Most nebulae are of vast size; some are hundreds of&nbsp;<a href=\"https://en.wikipedia.org/wiki/Light-year\" title=\"\" target=\"_top\">light-years</a>&nbsp;in diameter. A nebula that is visible to the human eye from Earth would appear larger, but no brighter, from close by.<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-7\" target=\"_top\">[7]</a>&nbsp;The&nbsp;<a href=\"https://en.wikipedia.org/wiki/Orion_Nebula\" title=\"Orion Nebula\" target=\"_top\">Orion Nebula</a>, the brightest nebula in the sky and occupying an area twice the angular diameter of the full Moon, can be viewed with the naked eye but was missed by early astronomers.<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-8\" target=\"_top\">[8]</a>&nbsp;Although denser than the space surrounding them, most nebulae are far less dense than any&nbsp;<a href=\"https://en.wikipedia.org/wiki/Vacuum\" title=\"Vacuum\" target=\"_top\">vacuum</a>&nbsp;created on Earth – a nebular cloud the size of the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Earth\" title=\"Earth\" target=\"_top\">Earth</a>&nbsp;would have a total mass of only a few&nbsp;<a href=\"https://en.wikipedia.org/wiki/Kilogram\" title=\"Kilogram\" target=\"_top\">kilograms</a>. Many nebulae are visible due to fluorescence caused by embedded hot stars, while others are so diffused that they can be detected only with long exposures and special filters. Some nebulae are variably illuminated by&nbsp;<a href=\"https://en.wikipedia.org/wiki/T_Tauri_star\" title=\"T Tauri star\" target=\"_top\">T Tauri</a>&nbsp;variable stars. Nebulae are often star-forming regions, such as in the &quot;<a href=\"https://en.wikipedia.org/wiki/Pillars_of_Creation\" title=\"Pillars of Creation\" target=\"_top\">Pillars of Creation</a>&quot; in the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Eagle_Nebula\" title=\"Eagle Nebula\" target=\"_top\">Eagle Nebula</a>. In these regions, the formations of gas, dust, and other materials &quot;clump&quot; together to form denser regions, which attract further matter, and eventually will become dense enough to form&nbsp;<a href=\"https://en.wikipedia.org/wiki/Star\" title=\"Star\" target=\"_top\">stars</a>. The remaining material is then believed to form&nbsp;<a href=\"https://en.wikipedia.org/wiki/Planet\" title=\"Planet\" target=\"_top\">planets</a>&nbsp;and other&nbsp;<a href=\"https://en.wikipedia.org/wiki/Planetary_system\" title=\"Planetary system\" target=\"_top\">planetary system</a>&nbsp;objects.</p></body></html>",
"id": "nebula",
"indexKeywords": [
"cluster",
"N",
"nebula",
"N, nebula"
],
"modifiedOn": "2022-05-24T11:13:40",
"ownerUserName": "admin",
"projectId": "project-deep-space-exploration",
"projectTitle": "Project Deep Space Exploration",
"projectUrl": "project-deep-space-exploration",
"smartLink": "https://docs.hedronlabs.org/smart/project-deep-space-exploration/nebula",
"statusName": "Under Review",
"title": "Nebula",
"tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
"url": "nebula"
}

Response fields

assigneeUserName Topic assignee's login.
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.
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.