V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WebPages
- WorkerJob
- WorkersRegistrar
V2

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
items	ExportItemModel
includeDocumentPermissions	Boolean	Whether export the documents' permissions.
documentPermissionTemplateMappingsNullable	DocumentPemissionTemplateMappingModel	Application relationship between docuemnts and permission templates.

Ƭ ExportItemModel

The need to be exported documents.

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

Ƭ DocumentPemissionTemplateMappingModel

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

Ƭ ExportModel

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

Ƭ ExportItemModel

Name	Type	Description	Example
typeNullable	string
itemsNullable	`Array<string>`

Ƭ DocumentPemissionTemplateMappingModel

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

Ƭ 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