Publish project
Publishes a project, creating or updating a publication.
Path Parameters
- project-idstringrequired
The ID of the project to publish.
Body
application/json
pubId
string The ID of the publication to create.
pubName
string The name of the publication to create.
isPublishOnlyReadyTopics
boolean Whether to publish only topics in the Ready status.
outputTags
array string[] An array of strings containing Output Tags to use.
pubVisibility
string enumThe target publication visibility. Specify Public, Restricted or Private.
- Public
- Restricted
- Private
publishedTocNodeIds
array string[] An array of strings containing IDs of the TOC nodes to publish. If not specified, the entire project is published.
updatedPubId
string The ID of the publication to update.
updateMode
string enumDefines which update mode to choose for the update. Specify FullReplace or Partial.
- FullReplace
- Partial
isReplacePubStyles
boolean Specifies whether to update CSS style files.
isReplacePubScripts
boolean Specifies whether to update JavaScript files.
site
string The domain of the site to assign a publication to.
Example
hedron-partners.clickhelp.comResponses
POST/projects/{project-id}/publish
{
"taskKey": "f8de60eb4ad8757c5a2b533afae6251aa"
}