Export

[POST] /system/api/export

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExportModel

Responses

[200] Success

binary

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

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

Parameters

Name	In	Type
sessionId	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExportModel

Responses

[200] Success

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

Parameters

Name	In	Type
sessionIdRequired	path	string

Responses

[200] Success

binary

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

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

Parameters

Name	In	Type
sessionIdRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
type	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

FilterModel

Responses

[200] Success

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

Parameters

Name	In	Type
reportIdRequired	path	string
extensionName	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExportPayload

Responses

[200] Success

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

Parameters

Name	In	Type
reportIdRequired	path	string
exportSettingTemplateIdRequired	path	string
overrideExportSettings	query	boolean

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExportPayload

Responses

[200] Success

Models

Ƭ ExportModel

Documents exporting model.

Name	Type	Description
items	ExportItemModel
includeDocumentPermissions	Boolean	Whether export the documents' permissions.
documentPermissionTemplateMappingsNullable	Array<DocumentPemissionTemplateMappingModel>	Application relationship between docuemnts and permission templates.

Ƭ ExportItemModel

The need to be exported documents.

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

Ƭ DocumentPemissionTemplateMappingModel

Name	Type	Description
documentIdNullable	string	Document id.
permissionTemplatesNullable	Array<string>	List of IDs of permission templates to be applied.

Ƭ ExportModel

Name	Type	Description
includeNullable	Array<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.
includeDocumentScheduleTasks	Boolean	Whether export tasks associated with a document.
documentPermissionTemplateMappingsNullable	Array<DocumentPemissionTemplateMappingModel>	Application relationship between docuemnts and permission templates.

Ƭ ExportItemModel

Name	Type
typeNullable	string
itemsNullable	Array<string>

Ƭ DocumentPemissionTemplateMappingModel

Name	Type	Description
documentIdNullable	string	Document id.
permissionTemplatesNullable	Array<string>	List of IDs of permission templates to be applied.

Ƭ FilterModel

Name	Type
filtersNullable	Array<string>

Ƭ ExportPayload

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