Документерра: руководство пользователя

[API] Получение страницы

Получение информации об одной странице.

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

Авторизация

Этот запрос требует базовой авторизации.

Если страница относится к открытой публикации, авторизация не требуется.

Параметры запроса

Параметры пути
id string

Идентификатор проекта или публикации, из которой следует взять указанную страницу.

topic-id string
Идентификатор страницы, о которой необходимо получить информацию. 

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles/nebula'
Образец тела ответа
JSON
{
"assigneeUserName": "admin",
"body": "<p>A&nbsp;nebula&nbsp;(<a href=\"https://en.wikipedia.org/wiki/Latin\" title=\"Latin\">Latin</a>&nbsp;for &#39;cloud&#39; or &#39;fog&#39;;<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-2\">[2]</a>&nbsp;pl.&nbsp;nebulae,&nbsp;nebulæ&nbsp;or&nbsp;nebulas<a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-3\">[3]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-4\">[4]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-5\">[5]</a><a href=\"https://en.wikipedia.org/wiki/Nebula#cite_note-6\">[6]</a>) is an&nbsp;<a href=\"https://en.wikipedia.org/wiki/Interstellar_cloud\" title=\"Interstellar cloud\">interstellar cloud</a>&nbsp;of&nbsp;<a href=\"https://en.wikipedia.org/wiki/Cosmic_dust\" title=\"Cosmic dust\">dust</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Hydrogen\" title=\"Hydrogen\">hydrogen</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Helium\" title=\"Helium\">helium</a>&nbsp;and other&nbsp;<a href=\"https://en.wikipedia.org/wiki/Plasma_(physics)\" title=\"Plasma (physics)\">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\">astronomical object</a>, including&nbsp;<a href=\"https://en.wikipedia.org/wiki/Galaxy\" title=\"Galaxy\">galaxies</a>&nbsp;beyond the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Milky_Way\" title=\"Milky Way\">Milky Way</a>. The&nbsp;<a href=\"https://en.wikipedia.org/wiki/Andromeda_Galaxy\" title=\"Andromeda Galaxy\">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\">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\">Vesto Slipher</a>,&nbsp;<a href=\"https://en.wikipedia.org/wiki/Edwin_Hubble\" title=\"Edwin Hubble\">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=\"\">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\">[7]</a>&nbsp;The&nbsp;<a href=\"https://en.wikipedia.org/wiki/Orion_Nebula\" title=\"Orion Nebula\">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\">[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\">vacuum</a>&nbsp;created on Earth – a nebular cloud the size of the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Earth\" title=\"Earth\">Earth</a>&nbsp;would have a total mass of only a few&nbsp;<a href=\"https://en.wikipedia.org/wiki/Kilogram\" title=\"Kilogram\">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\">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\">Pillars of Creation</a>&quot; in the&nbsp;<a href=\"https://en.wikipedia.org/wiki/Eagle_Nebula\" title=\"Eagle Nebula\">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\">stars</a>. The remaining material is then believed to form&nbsp;<a href=\"https://en.wikipedia.org/wiki/Planet\" title=\"Planet\">planets</a>&nbsp;and other&nbsp;<a href=\"https://en.wikipedia.org/wiki/Planetary_system\" title=\"Planetary system\">planetary system</a>&nbsp;objects.</p>",
"createdOn": "2021-05-10T12:32:25",
"ftsSnippetHtml": null,
"ftsTitleHtml": null,
"fullUrl": "https://docs.hedron.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>New topic created with API</title><script type=\"text/javascript\">//<!--\r\nvar articleTitleText='New topic created with API';\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.8462.34530\"/><script src=\"/resources/Scripts/project-deep-space-exploration/Script.js\" type=\"text/javascript\"></script><script src=\"/script-bundles/article-published.js?v=1.0.8462.34530\" 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-11-07T12:59:40",
"ownerUserName": "admin",
"projectId": "project-deep-space-exploration",
"projectTitle": "Project Deep Space Exploration",
"projectUrl": "project-deep-space-exploration",
"smartLink": "https://docs.hedron.org/smart/project-deep-space-exploration/nebula",
"statusName": "Under Review",
"title": "New topic created with API",
"tocNodeId": "cd1ad87f-55a4-46e5-b496-c3434d555cd1",
"url": "nebula"
}

Поля ответа

assigneeUserName Логин исполнителя, которому назначена страница.
body
Содержание тега <body> страницы. Возвращает значение null для всех способов, кроме Get Topic.
createdOn Временная метка ISO 8601 даты создания страницы. Часовой пояс GMT.
ftsSnippetHtml
Выделена HTML-разметка заголовка страницы с совпадениями с полнотекстовым поисковым запросом. Заполняется только в том случае, если isReturnSnippets больше нуля.
ftsTitleHtml
HTML-разметка сниппета контента страницы с выделенными соответствиями полнотекстовому поисковому запросу. Заполняется только в том случае, если isReturnSnippets больше нуля.
fullUrl
Полный URL-адрес страницы.
html
HTML-контент страницы. Возвращает значение null для всех способов, кроме Get Topic.
id
Идентификатор страницы.
indexKeywords
Массив строк, содержащих ключевые слова, связанные со страницей. Иерархические ключевые слова представляются в виде значений, разделенных запятыми.
modifiedOn
Временная метка ISO 8601 даты изменения страницы. Часовой пояс GMT.
ownerUserName
Логин владельца страницы.
projectId
Уникальный идентификатор проекта или публикации.
projectTitle
Название проекта или публикации, к которой относится данная страница. 
projectUrl
[устарело] То же, что и projectIds.
smartLink
Смарт-ссылка, сгенерированная для страницы.
statusName
Состояние рабочего процесса страницы.
title
Название страницы.
tocNodeId
Идентификатор элемента Дерева страниц, связанный со страницей.
url
[устарело] То же, что и id.