- V2
-
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
DataMonitoring
DataMonitoring
[POST] /api/data/monitorings
Request Schema
Response
Status Code: 200
Success
[DELETE] /api/data/monitorings
Request Schema
DataMonitoringDeleteRequestModel
Response
Status Code: 200
Success
[GET] /api/data/monitorings
Parameters
| Name | Type | Located In |
|---|---|---|
| orderby | string | query |
| limit | int32 | query |
| offset | int32 | query |
Response
Status Code: 200
Success
[PUT] /api/data/monitorings/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| id | string | query |
Request Schema
Response
Status Code: 200
Success
[GET] /api/data/monitorings/info/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| id | string | query |
Response
Status Code: 200
Success
[GET] /api/data/monitorings/detail/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| id | string | query |
Response
Status Code: 200
Success
[GET] /api/data/monitorings/count
Response
Status Code: 200
Success
[PUT] /api/data/monitorings/status
Request Schema
DataMonitoringStatusRequestModel
Response
Status Code: 200
Success
[PUT] /api/data/monitorings/rename/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| id | string | query |
Request Schema
newName
Response
Status Code: 200
Success
[PUT] /api/data/monitorings/description/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| id | string | query |
Request Schema
newDescription
Response
Status Code: 200
Success
Models
Ƭ DataMonitoringRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | ||
| descriptionNullable | string | ||
| dashboardIdNullable | string | ||
| query | QueryInfo | ||
| condition | ConditionInfo | ||
| notificationsNullable | NotificationInfo | ||
| notificationStrategy | NotificationStrategyInfo | ||
| executionPlan | RecurrenceInfo |
Ƭ QueryInfo
| Name | Type | Description | Example |
|---|---|---|---|
| documentIdNullable | string | ||
| aggregateModelsNullable | string | ||
| filtersNullable | string | ||
| valuesNullable | string | ||
| encryptReferenceTokenNullable | string | ||
| createdByIntegration | Boolean | ||
| fieldNullable | string | ||
| dimensionsNullable | string | ||
| userIdNullable | string | ||
| userNameNullable | string | ||
| userProviderNullable | string | ||
| tenantIdNullable | string |
Ƭ ConditionInfo
| Name | Type | Description | Example |
|---|---|---|---|
| operatorNullable | string | ||
| thresholdNullable | string |
Ƭ NotificationInfo
| Name | Type | Description | Example |
|---|---|---|---|
| channelNullable | string | ||
| contactsNullable | Contact | ||
| contentNullable | string |
Ƭ NotificationStrategyInfo
| Name | Type | Description | Example |
|---|---|---|---|
| typeNullable | string | ||
| definition | NotificationStrategyDefination |
Ƭ RecurrenceInfo
| Name | Type | Description | Example |
|---|---|---|---|
| patternNullable | string | ||
| startDateNullable | ISO DateTime Sting | ||
| endDateNullable | ISO DateTime Sting | ||
| timezoneIdNullable | string |
Ƭ Contact
| Name | Type | Description | Example |
|---|---|---|---|
| displayNameNullable | string | ||
| addressNullable | string | ||
| addressTypeNullable | string |
Ƭ NotificationStrategyDefination
| Name | Type | Description | Example |
|---|---|---|---|
| withinNullable | string | ||
| timeUnitNullable | string | ||
| totalSeconds | int64 |
Ƭ DataMonitoringDeleteRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| idListNullable | Array<string> |
Ƭ DataMonitoringStatusRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| idListNullable | Array<string> |
||
| enabled | Boolean |