Datasource

[POST] /api/v2/data/datasources

添加新的数据源。

请求数据格式

AddDataSourceRequestViewModelV2

返回值

状态码: 200

成功

AddDataSourceResponseViewModelV2

状态码: 400

错误的请求

DatasetPluginErrorV2

[PUT] /api/v2/data/datasources/{id}

更新数据源。

参数:

名称	类型	位置	描述
id必填项	string	path	数据源 ID。例如：15fd3940-e83c-19d7-246d-81b2ccb7e195

请求数据格式

UpdateDataSourceRequestViewModelV2

返回值

状态码: 200

成功

UpdateDatasourceResponseViewModelV2

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/{id}

通过其 ID 和（可选）其版本查询特定数据源的详细信息。

参数:

名称	类型	位置	描述
id必填项	string	path	要查询的数据源的唯一标识符。
version	int32	query	查询的数据源的版本。若未指定，则使用最新版本。
extendMetaData	Boolean	query	是否需要查询扩展信息

返回值

状态码: 200

成功

DataSourceV2ViewModel

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/{id}/download

下载数据源文档。

参数:

名称	类型	位置	描述
id必填项	string	path	文档编号。例如：05bb029e-0d75-dc4d-671b-87299a4a6907

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/datasources/search

根据提供的搜索条件分页查询数据源，包括对多租户、用户上下文和提取状态的支持。

请求数据格式

QueryDataSourceWithPaginationModel

返回值

状态码: 200

成功

QueryDataSourcesWithPaginationResponseModel

状态码: 400

错误的请求

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/task-status/{taskId}

通过任务id查询数据源任务状态。

参数:

名称	类型	位置	描述
taskId必填项	string	path	任务 ID，前缀为“datasource:”。例如：datasource：a10f7bbc-a416-46e5-ab19-e79e2293a88a

返回值

状态码: 200

成功

WorkerTaskStatusViewModelV2

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/providers

检索可用数据源提供程序的列表。

返回值

状态码: 200

成功

DataSourceProvidersResponseModel

状态码: 400

错误的请求

DatasetPluginErrorV2

[GET] /api/v2/data/datasources/{id}/query

查询数据源。

参数:

名称	类型	位置	描述
id必填项	string	path	数据源ID
query	string	query	查询
queryType	string	query	查询类型
format	string	query	格式
UnknownTypeHandle	string	query	未知类型的处理方式
MissParameterHandle	string	query	缺少参数的处理方式
RowLimit	string	query	行限制

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

[POST] /api/v2/data/datasources/{id}/query

查询数据源。

参数:

名称	类型	位置	描述
id必填项	string	path	数据源ID

请求数据格式

QueryDataSourceRequestBody

返回值

状态码: 200

成功

binary

状态码: 400

错误的请求

DatasetPluginErrorV2

状态码: 404

未找到

DatasetPluginErrorV2

类型定义

Ƭ AddDataSourceResponseViewModelV2

添加数据源的响应。

名称	类型	描述
id可为空	string	数据源 ID。
name可为空	string	数据源名称。
provider可为空	string	数据源提供程序。
supportNativeQuery	Boolean	数据源提供者支持原生查询。
isNativeDataProvider	Boolean	数据源提供者是本机数据提供者。

Ƭ DatasetPluginErrorV2

数据集插件错误模型

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	DatasetPluginErrorV2
extendedResult可为空	any	扩展结果

Ƭ AddDataSourceRequestViewModelV2

添加数据源的请求。

名称	类型	描述	示例
name	string	数据源名称。	`"Data source name."`
provider	string	数据源提供程序。	`"SqlServer"`
connectionString	string	连接字符串。	`"Server=host; Database=Database; User ID=sa; Password=Password;"`
useAdvancedConfig	Boolean	是否使用高级配置连接字符串，若不使用高级配置连接字符串，ConnectionString需要为Server="host";User ID="sa";Password="Password";Database="Database"。	`true`
extractInDatabase	Boolean	是否将数据抽取到数据库中。当 connectionString 包含 SourceType 字段且 SourceType 字段不是“文件系统”时，ExtractInDatabase 需要为 true
mappingConfig可为空	string	表/字段名称映射。

Ƭ UpdateDatasourceResponseViewModelV2

更新数据源的响应。

名称	类型	描述
id可为空	string	数据源 ID。
name可为空	string	数据源名称。
provider可为空	string	数据源提供程序。
useAdvancedConfig	Boolean	是否使用高级配置连接字符串。
connectionString可为空	string	连接字符串。
mappingConfigs可为空	TableMappingInfoViewModelV2	表/字段名称映射。

Ƭ TableMappingInfoViewModelV2

表示版本 2 中数据源中的表的映射信息，包括其原始名称和显示名称以及其列映射。

名称	类型	描述
tableOriginalName可为空	string	数据源中定义的表的原始名称。
tableDisplayName可为空	string	用于显示目的的表的名称可能比原始名称更用户友好或更具描述性。
columns可为空	ColumnMappingInfoViewModelV2	列映射信息集合，表示数据源中原始列名与其对应的显示名的映射。

Ƭ ColumnMappingInfoViewModelV2

表示版本 2 中数据源中列的映射信息，包括其原始名称和显示名称。

名称	类型	描述	示例
columnOriginalName可为空	string	数据源中定义的列的原始名称。
columnDisplayName可为空	string	用于显示目的的列名称可能比原始名称更用户友好或更具描述性。

Ƭ UpdateDataSourceRequestViewModelV2

更新数据源的请求。

名称	类型	描述	示例
name	string	数据源名称。	`"Data source name."`
provider	string	数据源提供程序。	`"SqlServer"`
connectionString	string	连接字符串。	`"Server=host; Database=Database; User ID=sa; Password=Password;"`
useAdvancedConfig	Boolean	是否使用高级配置连接字符串，若不使用高级配置连接字符串，ConnectionString需要为Server="host";User ID="sa";Password="Password";Database="Database"。	`true`
extractInDatabase	Boolean	是否将数据抽取到数据库中。当 connectionString 包含 SourceType 字段且 SourceType 字段不是“文件系统”时，ExtractInDatabase 需要为 true
mappingConfig可为空	string	表/字段名称映射。

Ƭ DataSourceV2ViewModel

表示具有版本 2 的配置和元数据的数据源实体。

名称	类型	描述
displayName可为空	string	数据源的显示名称。
id可为空	string	数据源的唯一标识符。
name可为空	string	数据源的名称。
fileName可为空	string	与数据源关联的文件名。
provider可为空	string	数据源的提供程序。
useAdvancedConfig	Boolean	指示数据源是否使用高级配置。
connectionString可为空	string	数据源的连接字符串。
mappingConfigs可为空	TableMappingInfoViewModelV2	数据源内表的映射配置。
useUserContext	Boolean	指示数据源中是否利用了用户上下文。
useMultiTenant	Boolean	指示数据源是否支持多租户。
isExtracted	Boolean	指示数据源是否已被抽取。
supportNativeQuery	Boolean	指示数据源是否支持原生查询。
supportDirectQuery	Boolean	指示数据源是否支持直连查询。
type可为空	string	数据源的类型。
editorConfig可为空	string	数据源的编辑器配置。
extendMetaData	DatasourceExtendMeta

Ƭ DatasourceExtendMeta

表示包含需要额外查询的元信息的预览模型。

名称	类型	描述
hasParameters	Boolean	指示数据源是否带有参数。
hasMultipleBaseAddresses	Boolean	指示数据源是否有多个基地址。
hasEndpointParameters	Boolean	指示数据源是否具有端点参数。

Ƭ QueryDataSourcesWithPaginationResponseModel

表示检索数据源列表以及分页信息的查询的响应模型。

名称	类型	描述	示例
data可为空	DataSourceV2ViewModel	数据源视图模型列表。每个模型都提供有关特定数据源的详细信息。
pagination	PaginationModel

Ƭ PaginationModel

表示数据集查询的分页详细信息，包括页面大小、当前页码和项目总数。

名称	类型	描述
pageSize	int32	获取或设置每页的项目数。这决定了每页显示多少个项目。
pageNumber	int32	获取或设置当前页码。这用于计算要显示的项目的偏移量。
total	int64	获取或设置所有页面的总项目数。这用于计算可用的总页数。

Ƭ QueryDataSourceWithPaginationModel

表示使用分页和过滤选项查询数据源的模型。

名称	类型	描述	示例
pageSize	int32	获取或设置分页的页面大小。	`10`
pageNumber	int32	获取或设置分页的当前页码。	`1`
orderBy可为空	string	获取或设置对结果进行排序的标准。	`"+name"`
search可为空	string	获取或设置用于过滤结果的搜索词。	`"sales"`
useMultiTenant可为空	Boolean	获取或设置一个值，指示是否根据多租户过滤结果。	`true`
useUserContext可为空	Boolean	获取或设置一个值，指示是否根据用户上下文过滤结果。
isExtracted可为空	Boolean	获取或设置一个值，该值指示是否根据数据源是否已被提取来过滤结果。	`true`
providers可为空	string	获取或设置要包含在结果中的提供程序。	`"SqlServer,Oracle"`
filterProviders可为空	string	获取或设置要从结果中排除的提供程序。	`"MySQL"`
extendMetaData可为空	Boolean	是否扩展元数据，如果为 true，我们会计算 HasParameters、HasMultipleBaseAddresses 和 HasEndpointParameters，否则这三个值始终为 true。	`true`

Ƭ WorkerTaskStatusViewModelV2

worker 任务状态视图模型。

名称	类型	描述
taskId可为空	string	任务 ID。
status	WorkerTaskStatusEnumV2
statusText可为空	string	任务状态。
startTime可为空	ISO DateTime Sting	开始时间。
endTime可为空	ISO DateTime Sting	时间结束。
errorMessage可为空	string	错误信息。
errorMessageKey可为空	string	错误消息键值。
context可为空	string	上下文。
extraInfo可为空	string	额外信息。

Ƭ WorkerTaskStatusEnumV2

Enum:

Standby
Running
PrimaryTaskFinished
PrimaryTaskFaulted
PrimaryTaskUserCancelled
Finished

任务状态。

* standby - 0 - 待机。
* running - 1 - 正在运行。
* primarytaskfinished - 2 - 主任务已完成。
* primarytaskfaulted - 3 - 主任务发生故障。
* primarytaskusercancelled - 4 - 主任务已被用户取消。
* finished - 7 - 已完成。

Ƭ DataSourceProvidersResponseModel

表示检索数据源提供程序的请求的响应模型，包含数据源类别及其各自提供程序的集合。

名称	类型	描述	示例
dataSourceProviders可为空	DataSourceCategoryViewModelV2	数据源类别及其各自提供程序的集合。

Ƭ DataSourceCategoryViewModelV2

表示版本 2 中的数据源提供程序的类别和配置详细信息。

名称	类型	描述
name可为空	string	数据源提供者的唯一名称标识符。
displayName可为空	string	为了演示目的而显示的数据源提供程序的名称。
category可为空	string	数据源提供程序所属的类别。
editorConfig可为空	string	JSON 格式的编辑器配置，指定用于配置数据源提供程序的 UI 元素和行为。
unavailable	Boolean	指示数据源提供程序当前是否不可用。
hasUserGuide	Boolean	指示数据源提供程序是否有可用的用户向导。

Ƭ QueryDataSourceRequestBody

查询数据源请求体

名称	类型	描述
datasourceParameters可为空	string	数据源参数
query可为空	string	查询
queryType可为空	string	查询类型
format可为空	string	格式
options	Options

Ƭ Options

名称	类型	描述
unknownTypeHandle可为空	string	未知类型的处理方式
missParameterHandle可为空	string	缺少参数的处理方式
rowLimit可为空	string	行限制