[API] Импорт в существующий проект

Импортирует документацию различных форматов в существующий проект.

POST projects/{project-id}/?action=import&format={formatType}

Авторизация

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

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

Параметры пути
project-id
string
Идентификатор проекта, в который нужно импортировать файл.
Параметры запроса
action
string
Действие, которое необходимо выполнить. Поддерживается только import.
format
string
Формат предоставления данных для импорта. Может быть url или base64.
Параметры тела запроса
importFormat string Формат импорта. Поддерживаемые значения: Word, Rtf, Epub, Odt, Html, Markdown, ProjectBackup, Docfx, AutoDocs.
inputFileContent
string
[опционально] Контент файла в формате base64. Требуется, если в качестве параметра запроса формата выбран base64. Если выбран формат url, этот параметр игнорируется.
inputFileName
string
[опционально] Имя файла с расширением. Требуется, если в качестве параметра запроса формата выбран base64 . Если выбран формат url, этот параметр игнорируется.
inputFileUrl
string [опционально] URL-адрес файла. Это может быть публичный URL (не требующий аутентификации) или ссылка на файл в Хранилище файлов Документерры. Требуется, если в качестве параметра запроса формата выбран url. Если выбран формат base64, этот параметр игнорируется.
options object Дополнительные парамерты импорта.
__type string

Тип папаметров импорта. Допустимые типы для форматов:

  • Для формата AutoDocsразрешен AutoDocsImportOptions.
  • Для формата Word разрешен WordImportOptions.
  • Для формата Rtf разрешен RtfImportOptions.
  • Для формата Epubразрешен EpubImportOptions.
  • Для формата Odtразрешен OdtImportOptions.
  • Для формата Htmlразрешен HtmlImportOptions.
  • Для формата Markdownразрешен MarkdownImportOptions.
  • Для формата ProjectBackupразрешен ProjectBackupImportOptions.
  • Для формата Docfxразрешен DocfxBackupImportOptions.
isDownloadExternalLinkedFiles bool [опционально] Загружать ли файлы, на которые есть ссылки в документе. По умолчанию False. Доступно для форматов: Word, Rtf, Epub, Odt, Html, Markdown, ProjectBackup, Docfx.
isDownloadExternalLinkedImages bool [опционально] Загружать ли изображения, на которые есть ссылки в документе. По умолчанию True. Доступно для форматов: Word, Rtf, Epub, Odt, Html, Markdown, ProjectBackup, Docfx.
tocGenerationType string [опционально] Определяет, как импортируемый документ будет разбит на страницы. Допустимые значения для форматов Word, Rtf, Epub, Odt: UseStyleOutline(Стилям (Заголовок 1, Заголовок 2...)), UseParagraphOutline(Уровень отступа абзаца), UseTcFields(Поля ТС), ImportAsSingleTopic(Импортировать как одну страницу). По умолчаниюUseStyleOutline. Допустимые значения для форматов Html, Markdown: UseParagraphOutline и ImportAsSingleTopic. По умолчанию ImportAsSingleTopic. 
maxTocOutlineLevel string [опционально] Максимальный уровень заголовков для импортируемого файла. По умолчанию 2. Доступно для форматов: Word, Rtf, Epub, Odt.
stylesProcessingType string [опционально] Настройка обработки стилей Документеррой. Допустимые значения: KeepPreciseStyles(Оставить оригинальные стили), OptimizeStyles(Оптимизировать стили), DoNotImportStyles(Оставить только структуру). По умолчанию OptimizeStyles. Доступно для форматов: Word, Rtf, Epub, Odt, Html, Markdown.
imageFormat string [опционально] Желаемый формат изображений: Png или Jpeg. По умолчанию Png. Доступно для форматов: Word, Rtf, Epub, Odt.
splitModeType string
[опционально] Режим импорта для формата AutoDocs: GroupMethods, SeparateTopics или SingleTopic.
updatedMountPointTocNodeId string [опционально] Идентификатор родительского элемента в Дереве страниц, который должен быть обновлен. Этот идентификатор соответствует tocNodeId, который можно получить с помощью метода получения страницы. Если этот параметр указан, все страницы этого элемента будут обновлены. Доступно для формата AutoDocs.

Примеры

Пример запроса
AutoDocs
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/api-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "AutoDocs",
    "inputFileUrl": "https://petstore.swagger.io/v2/swagger.json",
    "options": {
        "__type": "AutoDocsImportOptions",
        "splitModeType": "SeparateTopics",
        "updatedMountPointTocNodeId": "cf57d4a1-f4c1-48e7-8637-2d8270a0fc9b"
    }
}'
Word
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Word",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.docx",
    "options": {
        "__type": "WordImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "UseStyleOutline", 
        "maxTocOutlineLevel": 2, 
        "stylesProcessingType": "OptimizeStyles", 
        "imageFormat": "Png" 
  }
}'
Rtf
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Rtf",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.rtf",
    "options": {
        "__type": "RtfImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "UseStyleOutline",  
        "maxTocOutlineLevel": 2,
        "stylesProcessingType": "KeepPreciseStyles", 
        "imageFormat": "Jpeg" 
  }
}'
Epub
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Epub",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.epub", 
    "options": {
        "__type": "EpubImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "UseStyleOutline", 
        "maxTocOutlineLevel": 3, 
        "stylesProcessingType": "DoNotImportStyles", 
        "imageFormat": "Png" 
  }
}'
Odt
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Odt",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.odt", 
    "options": {
        "__type": "OdtImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "UseStyleOutline",
        "maxTocOutlineLevel": 3, 
        "stylesProcessingType": "OptimizeStyles", 
        "imageFormat": "Png" 
  }
}'
Html
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Html",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.zip", 
    "options": {
        "__type": "HtmlImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "ImportAsSingleTopic", 
        "stylesProcessingType": "OptimizeStyles"
  }
}'
Markdown
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Markdown",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.zip", 
    "options": {
        "__type": "MarkdownImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true, 
        "tocGenerationType": "ImportAsSingleTopic", 
        "stylesProcessingType": "KeepPreciseStyles"
  }
}'
ProjectBackup
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "ProjectBackup",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/project-backup.zip", 
    "options": {
        "__type": "ProjectBackupImportOptions", 
        "isDownloadExternalLinkedFiles": false, 
        "isDownloadExternalLinkedImages": true 
   }
}'
Docfx
Скопировать код
Bash (оболочка Unix)
curl --location --request POST 'https://{portal-url}/api/v1/projects/my-project/?action=import&format=url' \
--data-raw '{
    "importFormat": "Docfx",
    "inputFileUrl": "https://myportal.documenterra.net/resources/Storage/import-sample.zip", 
    "options": {
        "__type": "DocfxBackupImportOptions", 
        "isDownloadExternalLinkedFiles": false,
        "isDownloadExternalLinkedImages": true 
  }
}'
Пример тела ответа
Скопировать код
JSON
{
    "taskKey": "24685f07c1644b12add45da9df56ed6c"
}

Поля ответа

taskKey
Ключ задачи процесса импорта.