-
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
StreamingDatasetApi
StreamingDatasetApi
[GET] /api/streamingdatasets/{id}
Parameters
| Name | Type | Located In |
|---|---|---|
| idRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/streamingdatasets
Response
Status Code: 200
Success
[POST] /api/streamingdatasets
Request Schema
AddStreamingDatasetRequestModel
Response
Status Code: 200
Success
[POST] /api/streamingdatasets/{datasetId}/data
Parameters
| Name | Type | Located In |
|---|---|---|
| datasetIdRequired | string | path |
| pushDataToken | string | query |
Request Schema
Response
Status Code: 200
Success
[PUT] /api/streamingdatasets/{datasetId}
Parameters
| Name | Type | Located In |
|---|---|---|
| datasetIdRequired | string | path |
Request Schema
UpdateStreamingDatasetRequestModel
Response
Status Code: 200
Success
[POST] /api/streamingdatasets/rebuild-table/{datasetId}
Parameters
| Name | Type | Located In |
|---|---|---|
| datasetIdRequired | string | path |
Response
Status Code: 200
Success
Models
Ƭ AddStreamingDatasetRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | ||
| descriptionNullable | string | ||
| commentNullable | string | ||
| columnsNullable | Column | ||
| residenceTime | int64 | ||
| residenceTimeUnitNullable | string | ||
| pushDataTokenNullable | string | ||
| tagIdsNullable | Array<string> |
Ƭ Column
| Name | Type | Description | Example |
|---|---|---|---|
| addIndex | Boolean | ||
| nameNullable | string | ||
| dbColumnNameNullable | string | ||
| typeNullable | string | ||
| fieldDescriptionNullable | string | ||
| dataVizAIHint | DataVizAIHint |
Ƭ DataVizAIHint
Enum:
NoneCurrencyImageURLImageBinaryGeoRegionGeoLatitudeGeoLongitudeGeoCountryGeoProvinceGeoCityGeoDistrict
Ƭ InsertDataParamVO
| Name | Type | Description | Example |
|---|---|---|---|
| datasetIdNullable | string | ||
| columnsNullable | Array<string> |
||
| rowsNullable | Array<array> |
||
| overwrite | Boolean |
Ƭ UpdateStreamingDatasetRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| datasetIdNullable | string | ||
| isTableStructureChanged | Boolean | ||
| nameNullable | string | ||
| descriptionNullable | string | ||
| commentNullable | string | ||
| columnsNullable | Column | ||
| residenceTime | int64 | ||
| residenceTimeUnitNullable | string | ||
| pushDataTokenNullable | string | ||
| tagIdsNullable | Array<string> |