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

[API] Публикация проекта

Создает новую онлайн-публикацию.

POST projects/{project-id}? action=publish

Авторизация

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

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

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

project-id	string	Идентификатор проекта, который подлежит публикации.

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

pubId	string	Идентификатор создаваемой публикации.
pubName	string	Имя создаваемой публикации.
isPublishOnlyReadyTopics	bool	[опционально] Указывает, следует ли публиковать только разделы со статсом Готово.
outputTags	array of strings	[опционально] Массив строк, содержащих условные теги, которые необходимо применить.
pubVisibility	string	[опционально] Видимость целевой публикации.
publishedTocNodeIds	array of strings	[опционально] Массив строк, содержащих идентификаторы элементов Дерева страниц, которые подлежат публикации. Если не указано, публикуется весь проект.

Образцы

Образец запроса

Copy Code

Bash (Unix Shell)

curl --location -g --request POST 'https://{portal-url}/api/v1/projectsproject-deep-space-exploration?action=publish' ^
--data-raw '{
    "pubId": "space-program-api",
    "pubName": "Space Program API",
    "isPublishOnlyReadyTopics": true,
    "outputTags": [
        "OnlineDoc"
    ],
    "pubVisibility": "Public",
    "publishedTocNodeIds": [
        "0e7adad0-2572-4966-8f02-bc46930cf848"
    ]
}'