v8.0

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

PushDataset

[GET] /api/pushdatasets/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[POST] /api/pushdatasets

Request Schema

AddPushDatasetRequestModel

Response

Status Code: 200

Success

[PUT] /api/pushdatasets/{datasetId}

Parameters

Name	Type	Located In
datasetIdRequired	string	path

Request Schema

UpdatePushDatasetRequestModel

Response

Status Code: 200

Success

[POST] /api/pushdatasets/{datasetId}/data

Parameters

Name	Type	Located In
datasetIdRequired	string	path
pushDataToken	string	query

Request Schema

InsertDataParamVO

Response

Status Code: 200

Success

[DELETE] /api/pushdatasets/{datasetId}/data

Parameters

Name	Type	Located In
datasetIdRequired	string	path
pushDataToken	string	query

Request Schema

ClearDataParam

Response

Status Code: 200

Success

[POST] /api/pushdatasets/rebuild-table/{datasetId}

Parameters

Name	Type	Located In
datasetIdRequired	string	path

Response

Status Code: 200

Success

Models

Ƭ AddPushDatasetRequestModel

Name	Type	Description	Example
nameNullable	string
descriptionNullable	string
commentNullable	string
columnsNullable	Column
pushDataTokenNullable	string
tagIdsNullable	`Array<string>`
securityFilter	PushDatasetSecurityFilter

Ƭ Column

Name	Type	Description	Example
addIndex	Boolean
nameNullable	string
dbColumnNameNullable	string
typeNullable	string
fieldDescriptionNullable	string
dataVizAIHint	DataVizAIHint

Ƭ PushDatasetSecurityFilter

Name	Type	Description	Example
leftType	PushDatasetSecurityFilterRuleType
leftValueNullable	string
dataTypeNullable	string
operatorNullable	string
rightType	PushDatasetSecurityFilterRuleType
rightValueNullable	string
rightValue2Nullable	string
type	PushDatasetSecurityFilterType
itemsNullable	PushDatasetSecurityFilter

Ƭ DataVizAIHint

Enum:

None
Currency
ImageURL
ImageBinary
GeoRegion
GeoLatitude
GeoLongitude
GeoCountry
GeoProvince
GeoCity
GeoDistrict

Ƭ PushDatasetSecurityFilterRuleType

Enum:

Field
UserContext
OrganizationContext
Constant

Ƭ PushDatasetSecurityFilterType

Enum:

AndGroup
OrGroup
Rule

Ƭ UpdatePushDatasetRequestModel

Name	Type	Description	Example
datasetIdNullable	string
isTableStructureChanged	Boolean
nameNullable	string
descriptionNullable	string
commentNullable	string
columnsNullable	Column
pushDataTokenNullable	string
tagIdsNullable	`Array<string>`
securityFilter	PushDatasetSecurityFilter

Ƭ InsertDataParamVO

Name	Type	Description	Example
datasetIdNullable	string
columnsNullable	`Array<string>`
rowsNullable	`Array<array>`
overwrite	Boolean

Ƭ ClearDataParam

Name	Type	Description	Example
columnNameNullable	string
valueNullable	any
optionNullable	string