智能数据洞察 DATAARTS INSIGHT-保存或修改数据集:请求参数
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Workspace-Id |
是 |
String |
工作空间ID。获取方法请参见获取工作空间ID。 |
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
数据集ID。 |
caption |
是 |
String |
数据集语义化名称。 |
status |
否 |
String |
数据集状态:0,1。 |
description |
否 |
String |
数据集描述。 |
ds_id |
是 |
String |
数据源ID。 |
ds_name |
否 |
String |
数据源名称。 |
ds_type |
否 |
String |
数据源类型。 |
table_type |
是 |
String |
数据集类型:
|
resource_code |
否 |
String |
数据集资源标识。 |
physical_schema |
是 |
表4 object |
数据集物理schema。 |
logical_schema |
是 |
表6 object |
数据集逻辑schema。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
database_name |
是 |
String |
数据库。 |
is_fact_table |
是 |
Boolean |
是否为端点表。 |
schema_name |
否 |
String |
模式。 |
sql_text |
否 |
String |
查询SQL。 |
table_name |
是 |
String |
表名。 |
table_type |
是 |
String |
表类型:
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filed_schema |
否 |
表7 object |
字段选择信息。 |
variables |
否 |
Array of 表9 objects |
SQL变量列表。 |
relations |
否 |
Array of 表10 objects |
物理表关系。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
caption |
是 |
String |
字段名称。 |
origin_column_name |
是 |
String |
字段物理名称,即表中名称。 |
schema_name |
否 |
String |
字段所属schema。 |
table_name |
是 |
String |
字段所属名 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
default_values |
否 |
Array of objects |
变量默认值。 |
format |
否 |
String |
变量格式,针对日期时间类型变量有效。 |
name |
是 |
String |
变量名称 |
type |
是 |
String |
参数解释: 变量类型,目前支持文本、数值、日期、系统变量等类型。 约束限制: 不涉及 取值范围: 以下枚举值:
默认取值: 不涉及 |
use_scope |
是 |
String |
变量作用域,dataset|global。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
source_database_name |
是 |
String |
源表所属数据库名称。 |
source_schema |
否 |
String |
源表所属schema名称。 |
source_table_name |
是 |
String |
源表名称。 |
target_database_name |
是 |
String |
目标表所属数据库名称。 |
target_schema |
否 |
String |
目标表所属schema名称。 |
target_table_name |
是 |
String |
目标表名称。 |
join_type |
是 |
String |
关联类型。 |
relation |
是 |
String |
关系类型。 |
joins |
是 |
Array of 表11 objects |
关联键 |