Export publication

Export publication

Exports a publication in one of the supported formats.

Path Parameters
  • project-id
    string
    required

    The ID of the publication to export.

Body
application/json
format
string enum

One of the allowed case-sensitive export formats.

  • WebHelp
  • PureHtml
  • Markdown
  • Chm
  • Pdf
outputFileName
string

The full name of the output file. If the output file is written in ClickHelp File Storage (default), this should be a full file name, including the file path that starts with Storage/. If the output is written to an FTP server, this should be an FTP file name relative to the FTP directory in which the file is written.

ExampleStorage/export-files/deep-space-1.0-docs.zip
exportPresetName
string

For printed formats only. The name of the Export Preset to be used (e.g. "Default" or "Default - Single Topic").

ftpInfo
object

An object specifying FTP server connection settings. If the value is null, the output file will be written to your ClickHelp portal File Storage.

Responses
POST/projects/{project-id}/export


{
  "taskKey": "f8de60eb4ad8757c5a2b533afae6251aa"
}

OK