[]
(Showing Draft Content)

Import

Import

[POST] /system/api/import

Parameters

Name In Type Default
newId query boolean false
patch query string
docPrefix query string
docSuffix query string
share query string

Responses

[200] Success

[POST] /admin/api/import

Responses

[200] Success

ImportController+ImportResult

Type: [text/plain], [application/json], [text/json]

[GET] /admin/api/import/cancel/{sessionId}

Parameters

Name In Type
sessionIdRequired path string

Responses

[200] Success

[GET] /admin/api/import/process/{sessionId}

Parameters

Name In Type
sessionIdRequired path string

Responses

[200] Success

ImportController+ImportResult

Type: [text/plain], [application/json], [text/json]

[GET] /admin/api/import/status/{sessionId}

Parameters

Name In Type
sessionIdRequired path string

Responses

[200] Success

Models

Ƭ ImportController+ImportResult

Name Type
success Boolean
sessionIdNullable string
documentsNullable Array<ImportController+UploadDocument>
errorsNullable Array<ImportError>
settingsNullable Array<ImportController+UploadSetting>

Ƭ ImportController+UploadDocument

Name Type
titleNullable string
documentTypeNullable string
action DocumentOperation
warningsNullable Array<ImportError>

Ƭ ImportError

Name Type
errorCode int32
errorTextNullable string
contextNullable any

Ƭ ImportController+UploadSetting

Name Type
titleNullable string
typeNullable string
action ImportController+SettingOperation
existenceItemsNullable Array<string>

Ƭ DocumentOperation

Enum:

  • Add
  • Update
  • Ignore
  • Upgrade

Ƭ ImportController+SettingOperation

Enum:

  • Add
  • Update
  • NotFound
  • Ignore