Запросить демо

Вебинар о Лучших практиках единого источника · 25 июня 2024, 18:00 (МСК)

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

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

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

GET projects 

Авторизация

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

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/projects'
Образец тела ответа
JSON
[
{
"createdOn": "2021-04-07T15:50:15",
"fullUrl": "https://docs.hedronlabs.org/articles/project-deep-space-exploration",
"id": "project-deep-space-exploration",
"parentId": null,
"parentUrl": null,
"title": "Project Deep Space Exploration",
"url": "project-deep-space-exploration",
"visibility": "Private"
},
{
"createdOn": "2022-02-16T13:38:01",
"fullUrl": "https://docs.hedronlabs.org/articles/project-snippets",
"id": "project-snippets",
"parentId": null,
"parentUrl": null,
"title": "Snippets Project",
"url": "project-snippets",
"visibility": "Private"
}
]

Поля ответа

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

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

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

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

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