v1
- Account
- Admin
- AdminUpload
- Analysis
- AnalysisPreview
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataFileEntryPreview
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DingTalkAuthentication
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- Identity-Token
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- NotebookView
- 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
- ThirdParty
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WeChat4WorkAuthentication
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
v2

ScheduleTemplate

[POST] /api/admin/scheduleTemplates

Request Body

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

ScheduleTemplateViewModel

Responses

[200] Success

ScheduleTemplateViewModel

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

[GET] /api/admin/scheduleTemplates

Parameters

Name	In	Type
documentType	query	string

Responses

[200] Success

ScheduleTemplateViewModel

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

[PUT] /api/admin/scheduleTemplates/{id}

Parameters

Name	In	Type
idRequired	path	string
cascade	query	boolean

Request Body

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

ScheduleTemplateViewModel

Responses

[200] Success

[DELETE] /api/admin/scheduleTemplates/{id}

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

Models

Ƭ ScheduleTemplateViewModel

Name	Type
idNullable	string
nameNullable	string
descriptionNullable	string
documentTypeNullable	string
triggerInfo	TriggerInfo
deliveryInfo	DeliveryInfo
rolesNullable	`Array<string>`
referencedFilesNullable	`Array<FileModel>`
historyDataExpiryDurationNullable	string
enableRetryForFailure	Boolean

Ƭ TriggerInfo

Name	Type
startDateNullable	string
endDateNullable	string
timeZoneIdNullable	string
cronExpressionNullable	string

Ƭ DeliveryInfo

Name	Type
exportInfo	ExportInfo
deployment	DeploymentModel

Ƭ FileModel

Name	Type
nameNullable	string
creatorNullable	string

Ƭ ExportInfo

Name	Type
formatNullable	string
settingsNullable	string

Ƭ DeploymentModel

Name	Type
typeNullable	string
localDeployment	LocalDeploymentModel
emailDeployment	EmailDeploymentModel
wfsDeployment	WFSDeploymentModel
appMsgDeployment	AppMsgDeploymentModel
externalStorageDeployment	ExternalStorageDeploymentModel

Ƭ LocalDeploymentModel

Name	Type
allowAnonymousNullable	Boolean
storePolicy	StorePolicyModel

Ƭ EmailDeploymentModel

Name	Type
emailNullable	string
ccNullable	string
bccNullable	string
replyToNullable	string
subjectNullable	string
bodyNullable	string
bodyForEmptyDocumentNullable	string
attachmentTypeNullable	string
allowAnonymousNullable	Boolean
storePolicy	StorePolicyModel
useRichTextNullable	Boolean
allowUserChangeEmailToNullable	Boolean
allowUserChangeCcNullable	Boolean
allowUserChangeBccNullable	Boolean

Ƭ WFSDeploymentModel

Name	Type
fileNameNullable	string
fullPathNullable	string
overwrite	Boolean

Ƭ AppMsgDeploymentModel

Name	Type
appNameNullable	string
subjectNullable	string
bodyNullable	string
allowUserToChooseRecipientsNullable	Boolean
recipients	AppMsgRecipientsModel
urlNullable	string
attachmentTypeNullable	string
allowAnonymousNullable	Boolean
storePolicy	StorePolicyModel

Ƭ ExternalStorageDeploymentModel

Name	Type
storageIdNullable	string
storageNameNullable	string
storageTypeNullable	string

Ƭ StorePolicyModel

Name	Type
typeNullable	string
dateNullable	string
spanNullable	int32
unitNullable	string

Ƭ AppMsgRecipientsModel

Name	Type
organizationsNullable	`Array<string>`
rolesNullable	`Array<string>`
usersNullable	`Array<string>`