[API] Получение всех страниц из проекта/публикации

Получение информации по всем страницам проекта.

GET /projects/{id}/articles

Авторизация

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

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

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

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

Примеры

Пример запроса

Скопировать код

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/projects/project-deep-space-exploration/articles'

Пример тела ответа

Скопировать код

JSON

[
    {
        "assigneeUserName": null,
        "createdOn": "2021-04-07T15:54:18",
        "ftsSnippetHtml": null,
        "ftsTitleHtml": null,
        "fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration/outer-space",
        "html": null,
        "id": "outer-space",
        "indexKeywords": [],
        "modifiedOn": "2022-08-17T10:30:56",
        "ownerUserName": null,
        "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/outer-space",
        "statusName": null,
        "title": "Outer space",
        "tocNodeId": "0e7adad0-2572-4966-8f02-bc46930cf848",
        "url": "outer-space"
    },
    {
        "assigneeUserName": null,
        "createdOn": "2021-04-08T14:19:09",
        "ftsSnippetHtml": null,
        "ftsTitleHtml": null,
        "fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration/astronomical-objec",
        "html": null,
        "id": "astronomical-objec",
        "indexKeywords": [],
        "modifiedOn": "2022-09-20T09:33:14",
        "ownerUserName": null,
        "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/astronomical-objec",
        "statusName": null,
        "title": "Astronomical object",
        "tocNodeId": "928d32c6-579b-4e98-a79e-aae03f12f1b5",
        "url": "astronomical-objec"
    }
]

Поля ответа

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