- V1
-
V2
- Admin
- Common
- Custom-Themes
- Dashboard
- DataModel
- Dataset
- Datasource
- Documents
- Draft
- Identity
- Identity-Organization
- Identity-Role
- Identity-Token
- Identity-User
- K8s
- Language-Packages
- Languages
- QueueMonitor
- Reporting-CachingSettings
- Reporting-ExportTemplates
- Reporting-RenderResults
- Reporting-Reports
- Reporting-UserFunctions
- Scene
- Scheduler
- Shared-Resources
- Tags
- overview
Dataset
Dataset
[POST] /api/v2/data/datasets/{id}/export
Export dataset document.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | dataset document id. For example: 4d4dc304-8ae5-16e4-c790-a8b87a7246b2 |
Request Schema
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[PUT] /api/v2/data/datasets/cached-datasets/batch-refresh
Batch refresh dataset data.
Request Schema
BatchRefreshDatasetRequestModel
Response
Status Code: 200
Success
BatchRefreshDatasetTaskResultModel
Status Code: 400
Bad Request
[GET] /api/v2/data/datasets/{id}/download
Download a dataset document.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | document id. For example: 15fd3940-e83c-19d7-246d-81b2ccb7e195 |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/data/datasets/{id}/definition
Get dataset definition by id.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | dataset document id. For example: b305fb39-c9b0-4aa6-a462-b69733d991c3 |
| useView | Boolean | query | Whether to use view mode when querying dataset definition. Default is true. |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/data/datasets/empty
Create an empty dataset.
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/data/datasets/cached-datasets/list
Get all cached dataset
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/data/datasets/cached-datasets/cache-infos
Get all cached dataset
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| pageSize | int32 | query | The number of data displayed per page. -1 means all data. |
| pageNumber | int32 | query | Current page number.Start from 1. |
| orderBy | string | query | Indicates which column the data is sorted by. |
| search | string | query | Name filter. |
| invalid | Boolean | query | Whether to display only invalid data. |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[POST] /api/v2/data/datasets/push-datasets/{id}/append-data
Add Push Dataset data by id.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | Dataset id. For example: 96f08381-f07c-3b0f-5f43-e84491b1616b |
| pushDataToken | string | query | Push data token |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
[POST] /api/v2/data/datasets/push-datasets/{id}/clear-data
Delete Push Dataset data by datasetId according to conditions.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | Dataset id. For example: 96f08381-f07c-3b0f-5f43-e84491b1616b |
| pushDataToken | string | query | Push data token |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
[POST] /api/v2/data/datasets/streaming-datasets/{id}/append-data
Add Streaming DataSet Data by id.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | Dataset id. For example: 006fa63d-2b21-0433-5785-9c8751dba0b4 |
| pushDataToken | string | query | Push data token |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
[GET] /api/v2/data/datasets/{id}/query
Query dataset.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | dataset id |
| query | string | query | query |
| queryType | string | query | query type |
| format | string | query | format |
| UnknownTypeHandle | string | query | unknown type handle |
| MissParameterHandle | string | query | miss parameter handle |
| RowLimit | string | query | row limit |
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/data/datasets/{id}/query
Query dataset.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | dataset id |
Request Schema
Response
Status Code: 200
Success
binary
Status Code: 400
Bad Request
Status Code: 404
Not Found
Models
Ƭ DatasetPluginErrorV2
Dataset plugin error model
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | Error code | |
| messageNullable | string | Error message | |
| contextNullable | string | Error context | |
| innerError | DatasetPluginErrorV2 | ||
| extendedResultNullable | any | Extended result |
Ƭ DatasetExportModel
Represent a dataset export model.
| Name | Type | Description | Example |
|---|---|---|---|
| parameters | DatasetParameterItem | Get or set dataset export parameters. | |
| advancedSetting | ExportAdvancedSetting | ||
| fileTypeNullable | string | Get or set dataset export file type. | "json" |
Ƭ DatasetParameterItem
Represent a dataset Parameter item.
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | Get or set dataset export parameter name. | "age" |
| valueNullable | Array |
Get or set dataset export parameter value. | [18,21] |
Ƭ ExportAdvancedSetting
Represent a dataset export advanced setting.
| Name | Type | Description | Example |
|---|---|---|---|
| encodingNullable | string | Get or set csv file encoding. | "utf-8" |
| noHeader | Boolean | Get or set whether csv file has header. | true |
| columnsDelimiterNullable | string | Get or set csv file columns delimiter. | "," |
| rowsDelimiterNullable | string | Get or set csv file rows delimiter. | ";" |
| formatted | Boolean | Get or set whether json file is formated. | true |
| quotePropertyNames | Boolean | Get or set json file quote property names. | true |
| limit | int32 | Get or set file limit size. | 100 |
Ƭ BatchRefreshDatasetTaskResultModel
Represent a result model of batch refresh task.
| Name | Type | Description | Example |
|---|---|---|---|
| datasetIdNullable | string | Get or set dataset document id. | |
| success | Boolean | Get or set result of batch refresh task. | |
| errorCodeNullable | string | Get or set error code when the task fails. | |
| errorMessageNullable | string | Get or set error message when the task fails. | |
| taskIdNullable | string | Get or set batch refresh task id. |
Ƭ BatchRefreshDatasetRequestModel
Represent a batch refresh model.
| Name | Type | Description | Example |
|---|---|---|---|
| refreshDataSetIds | Array<string> |
Get or set refresh data set ids. | ["789ACE15-1C11-DFD0-312D-AA32EBA0AB67","51FC17FF-D490-42E1-D419-E7BBC83CCF53"] |
| cotSearchEntryInfosNullable | SearchEntryInfo | Get or set COT search entry infos. |
Ƭ SearchEntryInfo
Represent a COT search entry info.
| Name | Type | Description | Example |
|---|---|---|---|
| tenantIdNullable | string | Get or set tenant id. | "D2DA4850-FBD0-7022-E471-E3AEDAA140E3" |
| datasetIdNullable | string | Get or set dataset id. | "E2DD8243-8CD3-39F7-8FAE-E23E6AE0ECF2" |
Ƭ DatasetDefinitionV2
| Name | Type | Description | Example |
|---|---|---|---|
| parametersNullable | QueryParameterViewModelV2 | The parameter of dataset. | |
| fieldsNullable | FieldViewModelV2 | The field of dataset. |
Ƭ QueryParameterViewModelV2
| Name | Type | Description | Example |
|---|---|---|---|
| name | string | The name of parameter. | "parameterName" |
| parameterType | string | The type of parameter. Optional range: User Input, Constant, User Context, Organization Context. | "User Input" |
| parameterValueNullable | string | The value of parameter. If the ParameterType is User Context or Organization Context, the ParameterValue can not be empty, the value must come from User Context or Organization Context. | "email" |
| parameterDefaultValueNullable | string | The default value of parameter. If the ParameterType is User Input or Constant, the ParameterDefaultValue can not be empty. The ParameterDefaultValue must match the DataType. | "0" |
| dataType | string | The data type of oarameter. Optional range: Integer, Float, String, DateTime, Date, Boolean, Guid | "String" |
| multivalue | Boolean | Whether the parameter value is multivalue: true - parameter value is multivalue; false - parameter value is not multivalue. |
Ƭ FieldViewModelV2
| Name | Type | Description | Example |
|---|---|---|---|
| table | string | The table of this field. | "[dbo].[Products](6ec5c8c5-8948-464e-95d9-2ea22ca979f7)" |
| column | string | Field name. | "ProductID" |
| aliasNullable | string | Field alias. | "ProductIDAlias" |
| descriptionNullable | string | The description of this field. | "description" |
| dataType | string | Data type of field. Optional range: Number, String, DateTime, Date, Boolean, Guid. | "String" |
| dataVizAIHintNullable | string | The data visualization artificial intelligence hint of this field. Optional range: None, Currency, ImageURL, ImageBinary, GeoLatitude, GeoLongitude, GeoCountry, GeoRegion, GeoProvince, GeoCity, GeoDistrict. | "GeoLatitude" |
| formatNullable | string | The format of field. Optional range: g, N, '\('0.00, 0.00 '€', '£'0.00, '¥'0.00, d, D, t, T, P, E.<br />g - General; N - Number; '\)'0.00 - Currency USD; 0.00 '€' - Currency EUR; '£'0.00 - Currency GBP; '¥'0.00 - Currency JPY; d - ShortDate; D - LongDate; t - ShortTime; T - LongTime; P - Percentage; E - Scientific. | "P" |
| fieldType | string | Field type of field. Optional range: Normal, Category, Calculated, SqlExpression, Aggregation, GroupBy, GroupBySqlExpression, AggregationSqlExpression, measure, calculatedColumn. | "Normal" |
| aggregationNullable | string | The aggregation of this field. | "Sum" |
| rawTypeNullable | string | The row type of this field. If the FieldType is SqlExpression, the RawType is the result data type of sql expression. | "Int32" |
| msDescriptionNullable | string | The description in data source of this field. | "description" |
| clrTypeNullable | string | ||
| isContainTimeZoneNullable | Boolean | Whether contain time zone: true - contain time zone; false - not contain time zone. |
Ƭ EmptyDatasetResponseModel
Response of create empty dataset.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | The id of created empty dataset. |
Ƭ EmptyDatasetRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| name | string | Dataset name | |
| indexed | Boolean | Whether the dataset is a cached dataset: true - the dataset is cached dataset; false - the dataset is direct dataset. | true |
Ƭ DatasetCachesResultModel
Represent a result model of getting dataset cache.
| Name | Type | Description | Example |
|---|---|---|---|
| lastErrorDataNullable | string | Dataset cache last refresh error data. | |
| datasetIdNullable | string | Dataset document id. | |
| titleNullable | string | Dataset document title. | |
| displayNameNullable | string | Dataset cache display name. | |
| creatorNameNullable | string | Dataset document creator name. | |
| tenantIdNullable | string | Tenant id. | |
| rowCount | int64 | Dataset cache data row count. | |
| operationNullable | string | Datset cache operation. | |
| lastUpdatedNullable | ISO DateTime Sting | Dataset cache last update time. |
Ƭ DatasetCachesListResultModel
Represent a result model of getting dataset cache.
| Name | Type | Description | Example |
|---|---|---|---|
| datasetQueryInfosNullable | DatasetCacheListQueryInfo | Dataset query info list. | |
| pagination | PaginationInfo |
Ƭ DatasetCacheListQueryInfo
Represent dataset query info list.
| Name | Type | Description | Example |
|---|---|---|---|
| datasetIdNullable | string | Dataset document id. | |
| titleNullable | string | Dataset document title. | |
| displayNameNullable | string | Dataset cache display name. | |
| creatorNameNullable | string | Dataset document creator name. | |
| tenantIdNullable | string | Tenant id. | |
| rowCount | int64 | Dataset cache data row count. | |
| operationNullable | string | Datset cache operation. | |
| lastUpdatedNullable | ISO DateTime Sting | Dataset cache last update time. | |
| lastErrorDataNullable | string | Dataset cache last refresh error data. |
Ƭ PaginationInfo
Represent pagination info.
| Name | Type | Description | Example |
|---|---|---|---|
| pageSize | int32 | Data count per page. | |
| pageNumber | int32 | Current page number. | |
| total | int32 | Total data count. |
Ƭ InsertPushDataModel
Add Push Dataset Data
| Name | Type | Description | Example |
|---|---|---|---|
| columns | Array<string> |
Push Dataset data columns | ["id","name"] |
| rows | Array<array> |
Push Dataset data rows | [[0,"Lisa"],[1,"Bob"]] |
| overwrite | Boolean | Whether to fully overwrite the old data | true |
Ƭ ClearPushDataModel
Clear Push Dataset data
| Name | Type | Description | Example |
|---|---|---|---|
| columnNameNullable | string | Push Dataset data column name | "name" |
| valueNullable | any | Push Dataset data column value | "Lisa" |
| optionNullable | string | The option used for where clause. It supports >, <, = | "=" |
Ƭ InsertStreamingDataModel
Add Push Dataset Data
| Name | Type | Description | Example |
|---|---|---|---|
| columns | Array<string> |
Streaming Dataset data columns | ["id","name"] |
| rows | Array<array> |
Streaming Dataset data rows | [[0,"Lisa"],[1,"Bob"]] |
| overwrite | Boolean | Whether to fully overwrite the old data | true |
Ƭ QueryDataSetRequestBody
Query data set request body
| Name | Type | Description | Example |
|---|---|---|---|
| datasetParametersNullable | string | Datasource parameters | |
| queryNullable | string | Query | |
| queryTypeNullable | string | QueryType | |
| formatNullable | string | Format | |
| options | Options |
Ƭ Options
| Name | Type | Description | Example |
|---|---|---|---|
| unknownTypeHandleNullable | string | Unknown type handle | |
| missParameterHandleNullable | string | Miss parameter handle | |
| rowLimitNullable | string | Row limit |