Действие с проектом или публикацией

Действие с проектом или публикацией

Выполняет действие над проектом или публикацией (экспорт, скачивание, публикация или импорт).

  • action=publish: Создает новую онлайн-публикацию. Обязательные поля тела запроса: pubId, pubName.
  • action=publish: Обновляет существующую онлайн-публикацию. Обязательные поля тела запроса: updatedPubId, pubName, updateMode.
  • action=import: Импортирует новый контент в существующий проект. Обязательно нужно указать параметр format. Обязательные поля тела запроса для format=base64: importFormat, options, inputFileContent, inputFileName. Обязательные поля тела запроса для format=url: importFormat, options, inputFileUrl.
  • action=export: Экспортирует проект или публикацию в один из поддерживаемых форматов. Обязательные поля тела запроса: format, outputFileName.
  • action=download: Только для проектов. Создает резервную копию проекта в хранилище портала с указанным именем. Обязательные поля тела запроса: outputFileName.
Path Parameters
  • id
    string
    required

    Идентификатор проекта или публикации.

Query Parameters
  • action
    string enum
    required

    Действие: export, download, publish, or import.

    • export
    • download
    • publish
    • import
  • format
    string enum

    Обязательно для действия импорта (action=import).Формат предоставления данных для импорта. Можно указать url или base64.

    • url
    • base64
Body
application/json

Объединённые параметры тела запроса для действия с проектом или публикацией. Поля используются в зависимости от типа действия (например, 'projectName' для создания проекта, 'outputFileName' для загрузки резервной копии проекта).

projectName
string

Имя нового проекта. Обязательно при action=create.

projectId
string

Идентификатор нового проекта. Если не указано, будет сгенерирован на основе имени нового проекта. Используется когда action=create.

sourceType
string enum

Тип источника для создания проекта: Empty (по умаолчанию), Template, или Copy. Используется при action=create.

  • Empty
  • Template
  • Copy
sourceProjectId
string

Идентификатор существующего проекта, который будет использоваться в качестве источника. Обязательно, если sourceType имеет значение Template (используйте 'minimalist-template', 'api-documentation-template', 'coffee-break-template', 'colorize-template', 'mountain-peak-template' или 'stardust-template') или Copy (используйте идентификатор вашего существующего проекта). Используется при action=create.

languageFourLetterCode
string

Четырехбуквенный код языка нового проекта (например, 'en-US'). Если не указано, будет использован язык портала по умолчанию. Используется при action=create.

pubId
string

Идентификатор создаваемой публикации.

pubName
string

Имя создаваемой публикации.

isPublishOnlyReadyTopics
boolean

Указывает, следует ли публиковать только разделы со статусом Готово.

outputTags
array string[]

Массив строк, содержащих условные теги, которые необходимо применить.

pubVisibility
string enum

Видимость целевой публикации. Возможные значения Public, Restricted или Private. Для публикации открытой публикации укажите Public, закрытой - Restricted, приватной - Private.

  • Public
  • Restricted
  • Private
publishedTocNodeIds
array string[]

Массив строк, содержащих идентификаторы элементов Дерева страниц, которые подлежат публикации. Если не указано, публикуется весь проект.

updatedPubId
string

Идентификатор обновляемой публикации.

updateMode
string enum

Определяет, какой режим обновления выбрать. Укажите режим полного обновления FullReplace или частичного обновления Partial.

  • FullReplace
  • Partial
isReplacePubStyles
boolean

Указывает, следует ли заменять стили публикации. Доступно только в том случае, если установлен режим частичного обновления Partial. По умолчанию значение false.

isReplacePubScripts
boolean

Указывает, следует ли заменять скрипты публикации. Доступно только в том случае, если установлен режим частичного обновления. По умолчанию значение false.

format
string enum

Один из разрешенных форматов экспорта с учетом регистра символов.

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

Полное имя выходного файла. Если выходной файл сохраняется в хранилище файлов Документерры (по умолчанию), должно быть указано полное имя файла, включая путь к файлу, начинающийся с Storage/.

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

Только для печатных форматов. Полное название используемого Пресета экспорта.

ftpInfo
object

Объект, определяющий параметры подключения к FTP-серверу. Если указано значение null, выходной файл будет записан в хранилище файлов портала Документерра.

importFormat
string enum

Формат импорта.

  • Word
  • Rtf
  • Epub
  • Odt
  • Html
  • Markdown
  • ProjectBackup
  • Docfx
  • AutoDocs
inputFileContent
string

Контент файла в формате base64. Требуется, если в качестве параметра запроса формата выбран base64. Если выбран формат url, этот параметр игнорируется.

inputFileName
string

Имя файла с расширением. Требуется, если в качестве параметра запроса формата выбран base64 . Если выбран формат url, этот параметр игнорируется.

inputFileUrl
string

URL-адрес файла. Это может быть публичный URL (не требующий аутентификации) или ссылка на файл в Хранилище файлов Документерры. Требуется, если в качестве параметра запроса формата выбран url. Если выбран формат base64, этот параметр игнорируется.

site
string

Домен сайта для публикации.

Examplelibrary.documenterra.net
options
object

Additional import parameters.

newProjectId
string

Идентификатор нового проекта, в который нужно импортировать спецификацию. Следует указать либо newProjectId, либо newProjectName.

newProjectName
string

Имя нового проекта, в который нужно импортировать спецификацию. Следует указать либо newProjectId, либо newProjectName.

newProjectLanguageFourLetterCode
string

Четырехбуквенный код языка нового проекта, в который нужно импортировать спецификацию. Если не указано, используется код en-US.

Responses
POST/projects/{id}


{
  "taskKey": "f8de60eb4ad8757c5a2b533afae6251aa"
}

OK