[]
        
(Showing Draft Content)

Export

Export

[POST] /system/api/export

Request Schema

ExportModel

Response

Status Code: 200

Success

binary

[POST] /admin/api/export/{sessionId}

Parameters

Name Type Located In
sessionId string query

Request Schema

ExportModel

Response

Status Code: 200

Success

[GET] /admin/api/export/{sessionId}

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

binary

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

Parameters

Name Type Located In
sessionIdRequired string path

Response

Status Code: 200

Success

[POST] /admin/api/export/list/{type}

Parameters

Name Type Located In
type string query

Request Schema

FilterModel

Response

Status Code: 200

Success

[POST] /api/reporting/export/{reportId}/{extensionName}

Parameters

Name Type Located In
reportIdRequired string path
extensionName string query

Request Schema

ExportPayload

Response

Status Code: 200

Success

[POST] /api/reporting/exportTemplate/{reportId}/{exportSettingTemplateId}/{overrideExportSettings}

Parameters

Name Type Located In
reportIdRequired string path
exportSettingTemplateIdRequired string path
overrideExportSettings Boolean query

Request Schema

ExportPayload

Response

Status Code: 200

Success

Models

Ƭ ExportModel

Documents exporting model.

Name Type Description Example
items ExportItemModel
includeDocumentPermissions Boolean Whether export the documents' permissions.

Ƭ ExportItemModel

The need to be exported documents.

Name Type Description Example
documentsNullable Array<string> Need to be exported documents' ids.

Ƭ ExportModel

Name Type Description Example
includeNullable ExportItemModel Include export items.
excludeReferenceDocumentTypesNullable Array<string> The document types of the referenced documents that are not allowed to be exported.
includeDocumentPermissions Boolean Whether export the documents' permissions.

Ƭ ExportItemModel

Name Type Description Example
typeNullable string
itemsNullable Array<string>

Ƭ FilterModel

Name Type Description Example
filtersNullable Array<string>

Ƭ ExportPayload

Name Type Description Example
allowedClaimsNullable string
userFunctionsNullable any
exportFormatNullable string
parametersNullable Array
cacheRefreshIsRequired Boolean
settingsNullable string
interactiveActionsNullable Array<string>
skipEmptyReport Boolean
maxExecLimit int32