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

ScheduleTemplate

[POST] /api/admin/scheduleTemplates

Request Schema

ScheduleTemplateViewModel

Response

Status Code: 200

Success

ScheduleTemplateViewModel

[GET] /api/admin/scheduleTemplates

Parameters

Name	Type	Located In
documentType	string	query

Response

Status Code: 200

Success

ScheduleTemplateViewModel

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

Parameters

Name	Type	Located In
idRequired	string	path
cascade	Boolean	query

Request Schema

ScheduleTemplateViewModel

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

Models

Ƭ ScheduleTemplateViewModel

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

Ƭ TriggerInfo

Name	Type	Description	Example
startDateNullable	string
endDateNullable	string
timeZoneIdNullable	string
cronExpressionNullable	string

Ƭ DeliveryInfo

Name	Type	Description	Example
exportInfo	ExportInfo
deployment	DeploymentModel

Ƭ FileModel

Name	Type	Description	Example
nameNullable	string
creatorNullable	string

Ƭ ExportInfo

Name	Type	Description	Example
formatNullable	string
settingsNullable	string

Ƭ DeploymentModel

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

Ƭ LocalDeploymentModel

Name	Type	Description	Example
allowAnonymousNullable	Boolean
storePolicy	StorePolicyModel

Ƭ EmailDeploymentModel

Name	Type	Description	Example
emailNullable	string
replyToNullable	string
subjectNullable	string
bodyNullable	string
bodyForEmptyDocumentNullable	string
attachmentTypeNullable	string
allowAnonymousNullable	Boolean
storePolicy	StorePolicyModel
useRichTextNullable	Boolean
allowUserChangeEmailToNullable	Boolean

Ƭ WFSDeploymentModel

Name	Type	Description	Example
fileNameNullable	string
fullPathNullable	string
overwrite	Boolean

Ƭ AppMsgDeploymentModel

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

Ƭ ExternalStorageDeploymentModel

Name	Type	Description	Example
storageIdNullable	string
storageNameNullable	string
storageTypeNullable	string

Ƭ StorePolicyModel

Name	Type	Description	Example
typeNullable	string
dateNullable	string
spanNullable	int32
unitNullable	string

Ƭ AppMsgRecipientsModel

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