[]
(Showing Draft Content)

PushDataset

PushDataset

[GET] /api/pushdatasets/{id}

Parameters

Name In Type
idRequired path string

Responses

[200] Success

[POST] /api/pushdatasets

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

AddPushDatasetRequestModel

Responses

[200] Success

[PUT] /api/pushdatasets/{datasetId}

Parameters

Name In Type
datasetIdRequired path string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

UpdatePushDatasetRequestModel

Responses

[200] Success

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

Parameters

Name In Type
datasetIdRequired path string
pushDataToken query string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

InsertDataParamVO

Responses

[200] Success

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

Parameters

Name In Type
datasetIdRequired path string
pushDataToken query string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ClearDataParam

Responses

[200] Success

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

Parameters

Name In Type
datasetIdRequired path string

Responses

[200] Success

Models

Ƭ AddPushDatasetRequestModel

Name Type
nameNullable string
descriptionNullable string
commentNullable string
columnsNullable Array<Column>
pushDataTokenNullable string
tagIdsNullable Array<string>
securityFilter PushDatasetSecurityFilter
aiAssistantInfo AIAssistantInfoViewModel

Ƭ Column

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

Ƭ PushDatasetSecurityFilter

Name Type
leftType PushDatasetSecurityFilterRuleType
leftValueNullable string
dataTypeNullable string
operatorNullable string
rightType PushDatasetSecurityFilterRuleType
rightValueNullable string
rightValue2Nullable string
type PushDatasetSecurityFilterType
itemsNullable Array<PushDatasetSecurityFilter>

Ƭ AIAssistantInfoViewModel

The AIAssistantInfo class represents the AI assistant configuration for a dataset.

Name Type Description
enabled Boolean value indicating whether the dataset can be used in chat analysis.
descriptionNullable string The summary information of the dataset that will be used for AI to automatically retrieve the dataset
columnAssistantInfosNullable Array<ColumnAssistantInfoViewModel> The list of column assistant information, which contains the column name and its description.

Ƭ DataVizAIHint

Enum:

  • None
  • Currency
  • ImageURL
  • ImageBinary
  • GeoRegion
  • GeoLatitude
  • GeoLongitude
  • GeoCountry
  • GeoProvince
  • GeoCity
  • GeoDistrict

Ƭ PushDatasetSecurityFilterRuleType

Enum:

  • Field
  • UserContext
  • OrganizationContext
  • Constant

Ƭ PushDatasetSecurityFilterType

Enum:

  • AndGroup
  • OrGroup
  • Rule

Ƭ ColumnAssistantInfoViewModel

Represents information about a dataset column(field), including its name and description.

Name Type Description
columnNameNullable string Column(Field) Name
descriptionNullable string The summary information of the dataset fields that will be used for AI to automatically retrieve the dataset and relative columns.

Ƭ UpdatePushDatasetRequestModel

Name Type
datasetIdNullable string
isTableStructureChanged Boolean
nameNullable string
descriptionNullable string
commentNullable string
columnsNullable Array<Column>
pushDataTokenNullable string
tagIdsNullable Array<string>
securityFilter PushDatasetSecurityFilter
aiAssistantInfo AIAssistantInfoViewModel

Ƭ InsertDataParamVO

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

Ƭ ClearDataParam

Name Type
columnNameNullable string
valueNullable any
optionNullable string