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

[API] Получение списка публикаций, доступных авторизованному читателю

Получение списка публикаций, доступных авторизованному читателю.

GET users/{pr-login}/projects

Авторизация

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

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

Параметры пути
pr-login string
Логин авторизованного читателя для получения списка доступных публикаций.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/users/pr1/projects'
Образец тела ответа
JSON
[
{
"createdOn": "2022-05-10T12:04:13",
"fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration-publication",
"id": "project-deep-space-exploration-publication",
"parentId": "project-deep-space-exploration",
"parentUrl": "project-deep-space-exploration",
"title": "Project Deep Space Exploration Publication",
"url": "project-deep-space-exploration-publication",
"visibility": "Public"
},
{
"createdOn": "2022-05-26T14:18:57",
"fullUrl": "https://docs.hedronlabs.org/articles/making-robots-publication3",
"id": "making-robots-publication3",
"parentId": "project-making-robots",
"parentUrl": "project-making-robots",
"title": "Making Robots Publication3",
"url": "making-robots-publication3",
"visibility": "Public"
}
]

Поля ответа

createdOn Временная метка ISO 8601, отражающая дату создания проекта/публикации. Часовой пояс GMT.
fullUrl Полный URL-адрес проекта или публикации.
id
Уникальный идентификатор проекта или публикации.
parentId
Уникальный идентификатор родительского элемента. Возвращает null для проектов. Для публикаций возвращается идентификатор связанного с ними проекта.
parentUrl

[устарело] То же, что и parentId.

{TITLE} Название проекта или публикации.
url

[устарело] То же, что и id.

visibility
Видимость проекта/публикации. Всегда возвращается значение Private для проектов.