维度表管理
方舟5.3.3版本中新增维度表管理相关API。

1. 获取维度表字段‌

获取某个维度表下的所有字段。

1.1 接口地址

【GET】 /uba/api/project/dimensions/properties

1.2 请求参数示例

1
//【必填】通过urlPath传参,table为维度表名称
2
table=?
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

1.3 返回结果示例

1
[
2
{
3
//字段名
4
"id": "dim_product_id",
5
//数据类型
6
"dataType": "number",
7
//字段显示名称
8
"name": null,
9
//字段说明
10
"remark": null,
11
//是否启用 1为启动 0为禁用
12
"enable": 1,
13
//是否为关联字段 1为关联字段 0为非关联字段
14
"relation": 1
15
},
16
{
17
"id": "name",
18
"dataType": "string",
19
"name": null,
20
"remark": null,
21
"enable": 1,
22
//0表示非关联字段
23
"relation": 0
24
},
25
{
26
"id": "price",
27
"dataType": "number",
28
"name": null,
29
"remark": null,
30
"enable": 1,
31
"relation": 0
32
}
33
]
Copied!

1.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" http://127.0.0.1:4005/uba/api/project/dimensions/properties?table=dim_product
Copied!

2. 更新维度表

更新维度表中的数据,维度表必须是已经创建成。接口支持新增列和往表中添加数据。

2.1 接口地址

【POST】 /uba/api/project/dimensions/update

2.2 请求参数示例

1
{
2
//【必填】维度表名称,维度表必须存在
3
"table":"dim_product",
4
//【必填】需要上报数据的维度表字段和字段对应的类型,map结构,key为字段名,value为字段类型
5
"columns":{
6
//dim_product_id为字段名 number为数据类型
7
"dim_product_id":"number",
8
"name":"string",
9
"price":"number"
10
},
11
//【必填】维度属性值,可以多条
12
"rows":[
13
{
14
//一行值为map结构,key为字段名,value为字段对应的值,dim_product_id为列名,1为dim_product_id字段的值
15
"dim_product_id":1,
16
"name":"华为meta8",
17
"price":4999
18
},
19
{
20
"dim_product_id":11,
21
"name":"小米 K30",
22
"price":2699
23
}
24
]
25
}
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证
columns:维度表中的字段名和字段数据类型。
参数为map结构,key为字段名,value为字段对应的数据类型。数据类型支持:
    string:字符串;
    number:数值,包含整数和小数点数据;
    boolean:布尔,只包含 true/false;
    datetime:日期,如yyyy-MM-dd HH:mm:ss.SSS 或yyyy-MM-dd HH:mm:ss 或yyyy-mm-dd;
    array<string>:集合,字符串集合。
rows:要插入到维度表中的数据,一行一条记录,每条记录用map存储,key为字段名,value为字段对应的值,关联字段值不能为空。rows中的字段在columns中必须定义。
columns中必须包含维度表关联字段,并且关联字段在rows中的值不能为空;
如果数据库中已有的维度表字段数据类型和columns传入的不一致,会提示参数错误;
如果rows中指定的column在columns中没有指定字段的类型,会提示参数错误。

2.3 返回结果示例

1
{
2
"success":0
3
}
Copied!

2.4 接口调用示例

1
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
2
"table":"dim_product",
3
"columns":{
4
"dim_product_id":"number",
5
"name":"string",
6
"price":"number"
7
},
8
"rows":[
9
{
10
"dim_product_id":1,
11
"name":"华为meta8",
12
"price":4999
13
},
14
{
15
"dim_product_id":11,
16
"name":"小米 K30",
17
"price":2699
18
}
19
]
20
}' http://127.0.0.1:4005/uba/api/project/dimensions/update
Copied!

3 创建维度表‌

创建维度表,维度表必须不存在,第一次创建维度表时需要指定表名、关联字段、表字段并且至少包含一条初始化数据。

3.1 接口地址

【POST】 /uba/api/project/dimensions

3.2 请求参数示例

1
{
2
//【必填】维度表名称,维度表必须存在
3
"table":"dim_product",
4
//维度表展示名称,不能超过200个字符
5
"showName":"产品属性",
6
//关联字段
7
"relations":[
8
"dim_product_id"
9
],
10
//备注信息,不能超过200个字符
11
"remark":"",
12
//【必填】需要上报数据的维度表字段和字段对应的类型,map结构,key为字段名,value为字段类型
13
"columns":{
14
//dim_product_id为字段名 number为数据类型
15
"dim_product_id":"number",
16
"name":"string",
17
"price":"number"
18
},
19
//【必填】维度属性值,可以多条
20
"rows":[
21
{
22
//一行值为map结构,key为字段名,value为字段对应的值,dim_product_id为列名,1为dim_product_id字段的值
23
"dim_product_id":1,
24
"name":"华为meta8",
25
"price":4999
26
},
27
{
28
"dim_product_id":11,
29
"name":"小米 K30",
30
"price":2699
31
}
32
]
33
}
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证
relations:关联字段,可以指定多个,最多不能超过
columns:维度表中的字段名和字段数据类型。
参数为map结构,key为字段名,value为字段对应的数据类型。数据类型支持:
    string:字符串;
    number:数值,包含整数和小数点数据;
    boolean:布尔,只包含 true/false;
    datetime:日期,如yyyy-MM-dd HH:mm:ss.SSS 或yyyy-MM-dd HH:mm:ss 或yyyy-mm-dd;
    array<string>:集合,字符串集合。
rows:要插入到维度表中的数据,一行一条记录,每条记录用map存储,key为字段名,value为字段对应的值,关联字段值不能为空。rows中的字段在columns中必须定义。
columns中必须包含维度表关联字段,并且关联字段在rows中的值不能为空;
如果数据库中已有的维度表字段数据类型和columns传入的不一致,会提示参数错误;
如果rows中指定的column在columns中没有指定字段的类型,会提示参数错误。

3.3 返回结果示例

1
{
2
"success":0
3
}
Copied!

3.4 接口调用示例

1
curl -H "Content-Type:application/json" -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X POST --data '{
2
"table":"dim_product",
3
"showName":"商品维度表",
4
"relations":[
5
"dim_product_id"
6
],
7
"columns":{
8
"dim_product_id":"number",
9
"name":"string",
10
"price":"number"
11
},
12
"rows":[
13
{
14
"dim_product_id":1,
15
"name":"华为meta8",
16
"price":4999
17
},
18
{
19
"productId":11,
20
"name":"小米 K30",
21
"price":2699
22
}
23
]
24
}' http://127.0.0.1:4005/uba/api/project/dimensions
Copied!

4. 清空维度表‌

清空维度表中的所有记录。清空后维度表和字段都还存在,页面还可继续使用,但是表中没有任何一条记录,数据不可恢复。

4.1 接口地址

【DELETE】 /uba/api/project/dimensions/clear

4.2 请求参数示例

1
//【必填】通过urlPath传参,table为维度表名称
2
table=?
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

4.3 返回结果示例

1
{
2
"success":0
3
}
Copied!

4.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/uba/api/project/dimensions/clear?table=dim_product
Copied!

5. 删除维度表‌

删除维度表。删除后维度表和维度表的记录都会被删除,不可恢复。删除后维度表将不存在,页面也不能再继续使用。

5.1 接口地址

【DELETE】 /uba/api/project/dimensions/drop

5.2 请求参数示例

1
//【必填】通过urlPath传参,table为维度表名称
2
table=?
Copied!
认证参数:接口必传token和appKey两个参数,详情见 项目接口认证

5.3 返回结果示例

1
{
2
"success":0
3
}
Copied!

5.4 接口调用示例

1
curl -H "token:4113c9cad1c301113783f433e254888c" -H "appKey:31abd9593e9983ec" -X DELETE http://127.0.0.1:4005/uba/api/project/dimensions/drop?table=dim_product
Copied!
最近更新 2mo ago