Документерра: руководство пользователя
[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 | Логин исполнителя, которому назначена страница. |
---|---|
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. |