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

[API] Обновление публикации

Обновление существующей онлайн-публикации.

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

Авторизация

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

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

Параметры пути
project-id
 string
 Идентификатор проекта, к которому относится публикация. 
Параметры тела запроса
updatedPubId string
 Идентификатор обновляемой публикации.
pubName string
 Задаваемое имя публикации.
updateMode
string
Определяет, какой режим обновления выбрать. Укажите режим полного обновления FullReplace или частичного обновления Partial.
isReplacePubScripts
bool
[опционально] Указывает, следует ли заменять скрипты публикации.   Доступно только в том случае, если установлен режим частичного обновления. По умолчанию значение false.
isReplacePubStyles
bool
[опционально] Указывает, следует ли заменять стили публикации.   Доступно только в том случае, если установлен режим частичного обновления Partial. По умолчанию значение false.
isPublishOnlyReadyTopics
bool
[опционально] Указывает, следует ли публиковать только разделы со статсом Готово.
outputTags
array of strings
[опционально] Массив строк, содержащих условные теги, которые необходимо применить.
pubVisibility
string
[опционально] Видимость целевой публикации.
publishedTocNodeIds
array of strings
[опционально] Массив строк, содержащих идентификаторы элементов Дерева страниц, которые подлежат публикации. Если не указано, публикуется весь проект.

Образцы

Образец запроса
Copy Code
Bash (Unix Shell)
curl --location --request POST 'https://{portal-url}/api/v1/projectsproject-deep-space-exploration?action=publish' ^
--data-raw '{
    "updatedPubId":"space-program-api",
    "pubName": "Space Program API",
    "updateMode":"FullReplace",
    "isReplacePubScripts":true,
    "isReplacePubStyles":true,
    "isPublishOnlyReadyTopics": true,
    "outputTags": [
        "OnlineDoc"
    ],
    "pubVisibility": "Public",
    "publishedTocNodeIds": [
        "0e7adad0-2572-4966-8f02-bc46930cf848"
    ]
}'