-
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
- overview
- V2
Schedule
Schedule
[POST] /admin/api/schedule/testEmailSetting
Request Schema
ScheduleController+EmailSettingViewModel
Response
Status Code: 200
Success
[POST] /admin/api/schedule/testAppMessageSetting
Request Schema
ScheduleController+NotificationViewModel
Response
Status Code: 200
Success
[POST] /admin/api/notification/contacts/{channel}
Parameters
| Name | Type | Located In |
|---|---|---|
| channelRequired | string | path |
Request Schema
ScheduleController+NotificationViewModel
Response
Status Code: 200
Success
[POST] /admin/api/schedule/verifyLocation
Request Schema
Response
Status Code: 200
Success
[GET] /admin/api/schedule/reporttaskid
Response
Status Code: 200
Success
Array<string>
[POST] /api/schedule/workerTokens/validate
Parameters
| Name | Type | Located In |
|---|---|---|
| getCaller | string | header |
Request Schema
token
Response
Status Code: 200
Success
boolean
Models
Ƭ ScheduleController+EmailSettingViewModel
| Name | Type | Description | Example |
|---|---|---|---|
| mailProtocolNullable | string | ||
| googleClientIDNullable | string | ||
| googleClientSecretNullable | string | ||
| googleTokensNullable | string | ||
| smtpServerAddressNullable | string | ||
| smtpServerPort | int32 | ||
| enableSSL | Boolean | ||
| loginNullable | string | ||
| passwordNullable | string | ||
| senderNameNullable | string | ||
| senderEmailNullable | string | ||
| recipientEmailNullable | string | ||
| emailSubjectNullable | string | ||
| emailBodyNullable | string | ||
| useParentSmtpSettings | Boolean |
Ƭ ScheduleController+NotificationViewModel
Notification view model
| Name | Type | Description | Example |
|---|---|---|---|
| channelIdNullable | string | Channel id: channel$appName | |
| notificationConfigViewModel | ScheduleController+NotificationConfigViewModel | ||
| useParentAppMsgSettings | Boolean | use parent application message settings | |
| contactAddressNullable | string | contact address | |
| dingTalkSetting | ScheduleController+DingTalkSettingVO | ||
| weChatSetting | ScheduleController+WeChatSettingVO | ||
| slackSetting | ScheduleController+SlackSettingVO | ||
| msTeamsSetting | ScheduleController+MsTeamsSettingVO |
Ƭ ScheduleController+NotificationConfigViewModel
Notification configuration
| Name | Type | Description | Example |
|---|---|---|---|
| subjectNullable | string | Email subject | |
| contentNullable | string | Email Content |
Ƭ ScheduleController+DingTalkSettingVO
| Name | Type | Description | Example |
|---|---|---|---|
| appKeyNullable | string | WeChat app key | |
| appSecretNullable | string | Wechat app secret | |
| agentIdNullable | string | WeChat agent id |
Ƭ ScheduleController+WeChatSettingVO
| Name | Type | Description | Example |
|---|---|---|---|
| corpIdNullable | string | DingTalk corpId | |
| secretNullable | string | DingTalk Secret | |
| agentIdNullable | string | DingTalk agent id |
Ƭ ScheduleController+SlackSettingVO
| Name | Type | Description | Example |
|---|---|---|---|
| slack_UserOAuthTokenNullable | string | Slack oauth token |
Ƭ ScheduleController+MsTeamsSettingVO
| Name | Type | Description | Example |
|---|---|---|---|
| mS_AppIdNullable | string | MSTeams App id | |
| mS_TenantIdNullable | string | MSTeams tanent id | |
| mS_UsernameNullable | string | MSTeams username | |
| mS_PasswordNullable | string | MSTeams password |
Ƭ VerifyLocationViewModel
| Name | Type | Description | Example |
|---|---|---|---|
| locationNullable | string | ||
| taskIdNullable | string |