ClickHelp User Manual

[API] Update Publication

Updates an existing online publication.

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

Authentication

This request requires basic authentication.

Request Parameters

Path params

project-id	string	The ID of the project the publication belongs to.

Body params

updatedPubId	string	The ID of the publication to update.
pubName	string	The name of the publication to set.
updateMode	string	Defines which update mode to choose for the update. Specify FullReplace or Partial.
isReplacePubScripts	bool	[optional] Specifies whether to replace publication scripts. Available only if Partial update mode is set. false by default.
isReplacePubStyles	bool	[optional] Specifies whether to replace publication styles. Available only if Partial update mode is set. false by default.
isPublishOnlyReadyTopics	bool	[optional] Whether to publish only topics in the Ready status.
outputTags	array of strings	[optional] An array of strings containing Output Tags to use.
pubVisibility	string	[optional] The target publication visibility.
publishedTocNodeIds	array of strings	[optional] An array of strings containing IDs of the TOC nodes to publish. If not specified, the entire project is published.

Samples

Request sample

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"
    ]
}'

[API] Publish Project [API] Export Publication