元数据操作相关接口
新增元数据
通过此接口新建元数据模板,进行设定元数据名称、元数据分类、生成元数据标识编码、定义模板实体元素等操作。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:POST
- 请求路径:
/api/v1/open/meta/create
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
classifyCode | String | 是 | 本企业内的分类code | "sp" | |
metaName | String | 是 | 100 | 元数据名称 | |
metaCode | String | 是 | 100 | 元数据代码 | |
industryCategory | String | 是 | 行业分类一级 | ||
industrySpecific | String | 是 | 行业分类二级 | ||
industryTrade | String | 是 | 行业分类三级 | ||
industrySubclass | String | 是 | 行业分类四级 | ||
standard | String | 否 | 200 | 依据标准 | |
metaDesc | String | 否 | 1000 | 元数据描述 | |
metaItemCreateDTOS[i].itemCode | String | 是 | 50 | 属性编码 | |
metaItemCreateDTOS[i].englishName | String | 是 | 50 | 属性英文名 | |
metaItemCreateDTOS[i].chineseName | String | 是 | 50 | 属性中文名 | |
metaItemCreateDTOS[i].definition | String | 否 | 200 | 属性定义义 | |
metaItemCreateDTOS[i].inputNecessary | Integer | 否 | - | 是否是输入性,0-否,1-是 | |
metaItemCreateDTOS[i].required | Integer | 否 | - | 是否必填性,0-否,1-是 | |
metaItemCreateDTOS[i].uniqueField | Integer | 否 | - | 是否唯一性,0-否,1-是 | |
metaItemCreateDTOS[i].comment | String | 否 | 200 | 备注 | |
metaItemCreateDTOS[i].itemSchemaCreateDTO.dataType | Integer | 是 | 实体类型,1:字符型,2:数值型,3:日期型 | ||
metaItemCreateDTOS[i].itemSchemaCreateDTO.minLength | Integer | 否 | 最小长度 字符型:默认 0 | ||
metaItemCreateDTOS[i].itemSchemaCreateDTO.maxLength | Integer | 否 | 最大长度 字符型:默认 4000 | ||
metaItemCreateDTOS[i].itemSchemaCreateDTO.dateFormat | String | 否 | 日期格式 默认:YYYY-MM-DD |
请求示例
json
{
"classifyCode": "hxh",
"metaHandle": "88.608.8889/META_xz_20240516",
"metaName": "4342",
"metaCode": "xz888",
"standard": "",
"metaDesc": "",
"industryCategory": "M",
"industrySpecific": "75",
"industryTrade": "751",
"industrySubclass": "7517",
"metaItemCreateDTOS": [
{
"itemCode": "43242",
"englishName": "23423",
"chineseName": "24234",
"required": 0,
"uniqueField": 0,
"inputNecessary": 1,
"listItemNecessary": 0,
"itemSchemaCreateDTO": {
"minLength": 0,
"maxLength": 4000,
"dataType": "1"
}
},
{
"itemCode": "4325",
"englishName": "5423",
"chineseName": "24234343",
"required": 0,
"uniqueField": 0,
"inputNecessary": 1,
"listItemNecessary": 0,
"itemSchemaCreateDTO": {
"dataType": "2"
}
},
{
"itemCode": "635345",
"englishName": "24234",
"chineseName": "2343242",
"required": 0,
"uniqueField": 0,
"inputNecessary": 1,
"listItemNecessary": 0,
"itemSchemaCreateDTO": {
"dateFormat": "YYYY-MM-DD",
"dataType": "3"
}
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 10000 |
message | String | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 1,
"message": "成功",
"data": {
"metaHandle": "88.608.5288/META_fcc95749f59f428"
}
}
1
2
3
4
5
6
7
2
3
4
5
6
7
异常示例
json
{
"message": "接口参数错误:入参metaHandle异常:要修改的元数据不存在!",
"code": 60005
}
1
2
3
4
5
2
3
4
5
查询元数据
操作者通过此接口查询自己所创建的元数据模板,可查看元数据模板的基本信息及实体元素列表。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:GET
- 请求路径:
/api/v1/open/meta/info
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJz....... |
Content-Type | String | 是 | - | application/json | application/json |
- Query参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
metaHandle | String | 是 | - | 要查询的元数据标识 | "88.608.6688/META_123444444444" |
请求示例
json
/api/v1/open/meta/info?metaHandle=88.608.6688/META_1234
1
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 1 |
message | String | 状态码描述 | 成功 |
data | Object | 具体响应对象 |
- data 数据结构
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
classifyCode | String | 本企业内的分类code | "sp" |
metaHandle | String | 元数据标识 | "88.608.6688/META_xz_test2" |
metaName | String | 元数据名称 | |
metaCode | String | 元数据代码 | |
industryCategory | String | 行业分类一级 | |
industrySpecific | String | 行业分类二级 | |
industryTrade | String | 行业分类三级 | |
industrySubclass | String | 行业分类四级 | |
standard | String | 依据标准 | |
metaDesc | String | 元数据描述 | |
itemVOS[i].itemCode | String | 属性编码 | |
itemVOS[i].englishName | String | 属性英文名称 | |
itemVOS[i].chineseName | String | 属性中文名称 | |
itemVOS[i].definition | String | 属性定义 | |
itemVOS[i].inputNecessary | Integer | 是否是输入性,0-否,1-是 | |
itemVOS[i].required | Integer | 是否必填性,0-否,1-是 | |
itemVOS[i].uniqueField | Integer | 是否唯一性,0-否,1-是 | |
itemVOS[i].comment | String | 备注 | |
itemVOS[i].itemSchemaVO.dataType | Integer | 实体类型,1:字符型,2:数值型,3:日期型 | |
itemVOS[i].itemSchemaVO.minLength | Integer | 最小长度 | |
itemVOS[i].itemSchemaVO.maxLength | Integer | 最大长度 | |
itemVOS[i].itemSchemaVO.dateFormat | String | 日期格式 |
响应示例
json
{
"code": 1,
"message": "成功",
"data": {
"classifyCode": "sp",
"classifyName": "食品",
"metaHandle": "88.608.8889/META_xz_copy_test",
"metaName": "xz_copy_test副本转换",
"metaCode": "xz_copy_test",
"industry": "农、林、牧、渔业/农业/谷物种植/稻谷种植",
"industryCategory": "A",
"industrySpecific": "01",
"industryTrade": "011",
"industrySubclass": "0111",
"metaState": 1,
"metaContributor": "88.608.8889",
"standard": "这里是依据标准:嘿嘿嘿嘿嘿",
"metaDesc": "这里是描述:哈哈哈哈哈哈哈",
"createdTime": "2024-05-21 16:59:02",
"updatedTime": "2024-05-22 13:41:50",
"itemVOS": [
{
"itemIndex": 2000,
"itemCode": "code1",
"englishName": "en1",
"chineseName": "zh1",
"itemState": 0,
"definition": "这里是实体定义:呵呵呵呵",
"inputNecessary": 1,
"listItemNecessary": 0,
"required": 1,
"uniqueField": 1,
"comment": "这里是实体的备注:嘿哈嘿哈",
"itemSchemaVO": {
"dataType": 1,
"minLength": 0,
"maxLength": 4000,
"charRange": "这里是字符型值域"
}
},
{
"itemIndex": 2001,
"itemCode": "code2",
"englishName": "en2",
"chineseName": "zh2",
"itemState": 0,
"definition": "这里是实体定义:呵呵呵呵",
"inputNecessary": 1,
"listItemNecessary": 0,
"required": 1,
"uniqueField": 1,
"comment": "这里是实体备注:呵呵呵呵",
"itemSchemaVO": {
"dataType": 2,
"minLength": 0,
"maxLength": 38,
"accuracy": 1,
"numberRange": "[1,10]"
}
},
{
"itemIndex": 2002,
"itemCode": "code3",
"englishName": "en3",
"chineseName": "zh3",
"itemState": 0,
"definition": "这里是实体定义:呵呵呵呵",
"inputNecessary": 1,
"listItemNecessary": 0,
"required": 1,
"uniqueField": 1,
"comment": "这里是实体备注:呵呵呵呵",
"itemSchemaVO": {
"dataType": 3,
"dateFormat": "YYYY-MM-DD"
}
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
异常示例
json
{
"message": "元数据不存在",
"code": 604
}
1
2
3
4
2
3
4
编辑元数据基本信息
操作者通过此接口编辑自己所创建的元数据模板,进行元数据基本信息的修改操作。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:PUT
- 请求路径:
/api/v1/open/meta/update-basic-info
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
classifyCode | String | 是 | 本企业内的分类code | "sp" | |
metaHandle | String | 是 | 255 | 元数据标识 | "88.608.6688/META_xz_test2" |
metaName | String | 是 | 100 | 元数据名称 | |
metaCode | String | 是 | 100 | 元数据代码 | |
industryCategory | String | 是 | 行业分类一级 | ||
industrySpecific | String | 是 | 行业分类二级 | ||
industryTrade | String | 是 | 行业分类三级 | ||
industrySubclass | String | 是 | 行业分类四级 | ||
standard | String | 否 | 200 | 依据标准 | |
metaDesc | String | 否 | 1000 | 元数据描述 |
请求示例
json
{
"classifyCode": "PEIFUBEN",
"metaHandle": "88.608.6688/META_xz_test2",
"metaName": "xz_test2",
"metaCode": "xz_test2_code",
"standard": "依据标准内容000000",
"metaDesc": "描述内容.....",
"industryCategory": "E",
"industrySpecific": "50",
"industryTrade": "502",
"industrySubclass": "5022",
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 10000 |
message | String | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 10000,
"message": "成功"
}
1
2
3
4
2
3
4
异常示例
json
{
"message": "接口参数错误:入参metaHandle异常:要修改的元数据不存在!",
"code": 60005
}
1
2
3
4
5
2
3
4
5
编辑元数据实体列表
操作者通过此接口编辑自己所创建的元数据模板,进行元数据模板实体元素的修改操作。
注:用户仅可修改自己创建的元数据模板相关信息。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:PUT
- 请求路径:
/api/v1/open/meta/update-item
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
metaHanlde | String | 是 | 元数据标识 | ||
metaItemDTOS[i].itemCode | String | 是 | 50 | ||
metaItemDTOS[i].itemIndex | Integer | 否 | 传按传的顺序来,如果不传会从已有itemIndex 顺排 | ||
metaItemDTOS[i].englishName | String | 是 | 50 | ||
metaItemDTOS[i].chineseName | String | 是 | 50 | ||
metaItemDTOS[i].definition | String | 否 | 实体值域定义 | ||
metaItemDTOS[i].itemState | Integer | 否 | 元素状态;0:启用,1:禁用(逻辑删除),2:未生效 | ||
metaItemDTOS[i].inputNecessary | Integer | 否 | - | 是否是输入性,0-否,1-是 | |
metaItemDTOS[i].required | Integer | 否 | - | 是否必填性,0-否,1-是 | |
metaItemDTOS[i].uniqueField | Integer | 否 | - | 是否唯一性,0-否,1-是 | |
metaItemDTOS[i].comment | String | 否 | 200 | 备注 | |
metaItemDTOS[i].itemSchemaCreateDTO.dataType | Integer | 是 | 实体类型,1:字符型,2:数值型,3:日期型 | ||
metaItemDTOS[i].itemSchemaCreateDTO.minLength | Integer | 否 | 最小长度 | ||
metaItemDTOS[i].itemSchemaCreateDTO.maxLength | Integer | 否 | 最大长度 | ||
metaItemDTOS[i].itemSchemaCreateDTO.dateFormat | String | 否 | 日期格式 默认:YYYY-MM-DD |
请求示例
json
{
"metaHandle": "88.608.666888/META_648052609c",
"metaItemDTOS": [
{
"itemCode": "code2",
"englishName": "en2",
"chineseName": "zh2",
"itemState": 0,
"required": 0,
"uniqueField": 0,
"inputNecessary": 1,
"itemSchemaCreateDTO": {
"dataType": "2"
},
"itemReferenceDTO": {}
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 10000 |
message | String | 状态码描述 | 成功 |
响应示例
json
{
"code": 10000,
"message": "成功"
}
1
2
3
4
2
3
4
异常示例
json
{
"message": "接口参数错误:入参metaHandle异常:要修改的元数据不存在!",
"code": 60005
}
1
2
3
4
5
2
3
4
5
删除元数据
通过此接口,用户可删除元数据模板;删除功能支持单个删除或批量删除元数据模板。
注意:
1、未发布元数据模板,可直接进行删除,已发布元数据模板,需撤回发布后,方可进行删除; 2、用户仅可删除自己创建的元数据模板
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:Delete
- 请求路径:
/api/v1/open/meta/delete
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Query参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
metaHandleList | Array <string> | 是 | - | 要操作的标识列表 | [ "88.608.6688/META_123444444444", "88.608.6688/META_123"] |
请求示例
json
/api/v1/open/meta/delete?metaHandleList=88.608.8889/META_3456&metaHandleList=88.608.8889/META_34563333
1
2
2
响应数据
参数 | 类型 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|
code | Integer | - | 状态码(详见状态码说明) | 10000 |
message | String | - | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 10000,
"message": "成功",
}
1
2
3
4
5
2
3
4
5
异常示例
json
{
"message": "元数据删除失败:[88.608.8889/META_xz_test_schemaDTO]元数据不是自己创建,不能删除",
"code": 606
}
1
2
3
4
5
6
2
3
4
5
6
元数据授权
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:POST
- 请求路径:
/api/v1/open/meta/grant/info
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
scope | Integer | 是 | - | 授权范围:1-公开 2-指定范 围 | |
metaHandle | String | 是 | 元数据标识 | ||
handleUsers | Array <string> | 否 | - | 新增身份标识 | [ "88.608.6688/META_123444444444", "88.608.6688/META_123"] |
removeHandleUsers | Array <string> | 否 | - | 删除身份标识 | [ "88.608.6688/META_123444444444", "88.608.6688/META_123"] |
请求示例
json
{
"scope": 2,
"metaHandle": "88.608.8889/META_qwert11",
"handleList": [
"88.608.8889/User_zhaohan"
],
"removeHandleUsers": [
"88.608.8889/User_zhao"
]
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 10000 |
message | String | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 10000,
"message": "成功"
}
1
2
3
4
5
2
3
4
5
异常示例
json
{
"message": "validate.bind.error",
"data": {
"errors": [
{
"name": "metaHandleList",
"errorMsg": "入参元数据标识列表metaHandleList不能为空"
}
]
},
"code": 30000
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
发布/撤回元数据
通过此接口,可发布未发布的元数据模板,发布后,可基于该元数据模版进行标识数据创建; 可撤回已发布的元数据模板;未发布的元数据模板不可被解析,不能继续进行标识数据的创建;已创建标识数据不受其影响。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:PUT
- 请求路径:
/api/v1/open/meta/publish-or-withdraw
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
metaHandleList | Array <string> | 是 | - | 要操作的标识列表 | [ "88.608.6688/META_123444444444", "88.608.6688/META_123"] |
opType | String | 是 | - | 操作类型,枚举值 publish 或 withdraw | "publish" |
请求示例
json
{
"metaHandleList": [
"88.608.8889/META_3456",
"88.608.8889/META_qwert11",
"88.608.8889/META_xz_update_basic",
"88.608.8889/META_345678990"
],
"opType": "publish"
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 10000 |
message | String | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 10000,
"message": "成功",
"data": [
{
"metaHandle": "88.608.8889/META_3456",
"state": "success",
"reason": ""
},
{
"metaHandle": "88.608.8889/META_qwert11",
"state": "success",
"reason": ""
},
{
"metaHandle": "88.608.8889/META_xz_update_basic",
"state": "success",
"reason": ""
},
{
"metaHandle": "88.608.8889/META_345678990",
"state": "failed",
"reason": "元数据标识88.608.8889/META_345678990不存在"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
异常示例
json
{
"message": "validate.bind.error",
"data": {
"errors": [
{
"name": "metaHandleList",
"errorMsg": "入参元数据标识列表metaHandleList不能为空"
}
]
},
"code": 30000
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
创建元数据副本
通过此接口,用户可参照其他企业的元数据模板创建自己的元数据模板,并在该元数据下进行标识注册。
注意:
- 用户仅可对授权给自己查看权限或公开的元数据模板创建副本;
- 创建副本成功后,该元数据模板不可对实体元素进行编辑。
- 创建副本成功后,该元数据仅可向本企业应用身份或身份组进行授权(若有其他企业需要创建该元数据模板副本,应向原元数据模板所有者索要权限);
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:POST
- 请求路径:
/api/v1/open/meta/baseon-create
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | admin |
Content-Type | String | 是 | - | application/json | application/json |
- Body参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
baseonHandle | String | 是 | - | 要引用的元数据标识 | |
baseInfo.metaCode | String | 是 | 50 | 设置的元数据编码 | |
baseInfo.classifyCode | String | 是 | 所属的本企业分类 |
请求示例
json
{
"baseonHandle": "88.608.6688/META_xz_contains_all",
"baseInfo": {
"metaCode": "xzcopy1",
"classifyCode": "sp"
}
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
响应数据
参数 | 类型 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|
code | Integer | - | 状态码(详见状态码说明) | 10000 |
message | String | - | 状态码描述 | 成功 |
- 响应参数
响应示例
json
{
"code": 1,
"message": "成功",
"data": {
"metaHandle": "88.608.5288/META_9c55c22e31"
}
}
1
2
3
4
5
6
7
2
3
4
5
6
7
异常示例
json
{
"message": "没有权限查看数据",
"code": 60001
}
1
2
3
4
5
2
3
4
5
数据分类列表
操作者通过此接口查询本企业下全量的数据分类列表。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:GET
- 请求路径:
/api/v1/open/meta/classify-query
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJz....... |
Content-Type | String | 是 | - | application/json | application/json |
- Query参数: 无
请求示例
json
/api/v1/open/meta/classify-query
1
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 1 |
message | String | 状态码描述 | 成功 |
data | Object | 具体响应对象 |
- data 数据结构
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
classifyCode | String | 本企业内的分类code | "sp" |
classifyName | String | 分类名称 | |
id | Integer | 分类id | |
parentId | Integer | 父id | |
sort | Integer | 排序 | |
children | Array[] | 子集 | |
level | Integer | 层级 |
响应示例
json
{
"code": 1,
"message": "成功",
"data": [
{
"id": 49,
"parentId": 0,
"sort": 0,
"children": [],
"classifyName": "未分类",
"classifyCode": "UN_CLASSIFIED",
"ancestors": "0",
"level": 1
},
{
"id": 48,
"parentId": 0,
"sort": 1,
"children": [
{
"id": 50,
"parentId": 48,
"sort": 1,
"children": [
{
"id": 51,
"parentId": 50,
"sort": 1,
"children": [],
"classifyName": "dz",
"classifyCode": "dz",
"ancestors": "0,48,50",
"level": 3
}
],
"classifyName": "dsf",
"classifyCode": "fsd",
"ancestors": "0,48",
"level": 2
}
],
"classifyName": "新类型",
"classifyCode": "NEW_CODE",
"ancestors": "0",
"level": 1
},
{
"id": 52,
"parentId": 0,
"sort": 1,
"children": [
{
"id": 53,
"parentId": 52,
"sort": 1,
"children": [],
"classifyName": "二级目录1-0627",
"classifyCode": "20240627101101",
"ancestors": "0,52",
"level": 2
},
{
"id": 54,
"parentId": 52,
"sort": 2,
"children": [],
"classifyName": "二级目录2-0627",
"classifyCode": "20240627101202",
"ancestors": "0,52",
"level": 2
},
{
"id": 57,
"parentId": 52,
"sort": 3,
"children": [],
"classifyName": "二级目录0-0627",
"classifyCode": "202406271106",
"ancestors": "0,52",
"level": 2
}
],
"classifyName": "一级目录-0627",
"classifyCode": "202406271011",
"ancestors": "0",
"level": 1
},
{
"id": 55,
"parentId": 0,
"sort": 2,
"children": [
{
"id": 56,
"parentId": 55,
"sort": 1,
"children": [],
"classifyName": "这是个目录-代码与元数据的重复测试",
"classifyCode": "20240627119",
"ancestors": "0,55",
"level": 2
}
],
"classifyName": "一级目录-0627-02",
"classifyCode": "202406271023",
"ancestors": "0",
"level": 1
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
异常示例
json
{
"code": 101,
"message": "无效的token"
}
1
2
3
4
2
3
4
元数据列表
操作者通过此接口获取某个数据分类下的元数据模板列表。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:GET
- 请求路径:
/api/v1/open/meta/page
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJz....... |
Content-Type | String | 是 | - | application/json | application/json |
- Query参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
classifyCode | String | 是 | - | 分类code | "NEW_code" |
metaHandle | String | 否 | - | 元数据标识 | |
metaState | Integer | 否 | - | 0-未发布 1-已发布 | |
startTime | String | 否 | - | 开始时间 yyyy-MM-dd HH:mm:ss | |
endTime | String | 否 | - | 结束时间 yyyy-MM-dd HH:mm:ss | |
page | Integer | 否 | - | 默认值0 | |
size | Integer | 否 | - | 默认值10 |
请求示例
json
/api/v1/open/meta/page?classifyCode=NEW_CODE&page=0&size=10
1
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 1 |
message | String | 状态码描述 | 成功 |
data | Object | 具体响应对象 |
- data 数据结构
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
metaHandle | String | 元数据标识 | "" |
metaName | String | 元数据名称 | "" |
classifyName | String | 所属分类名称 | |
id | Integer | 元数据id | |
metaCode | String | 元数据编码 | |
metaState | Integer | 元数据状态 0-未发布 1-发布 | |
createdTime | String | 元数据创建时间 | |
isQuote | Integer | 是否为副本 0-否 1-是 |
响应示例
json
{
"code": 1,
"message": "成功",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalCount": 1,
"totalPage": 1,
"content": [{
"metaHandle": "88.608.5288/META_f90c212ea7ec471",
"metaCode": "peijian",
"metaName": "电脑配件",
"metaState": 1,
"isQuote": 0,
"createdTime": "2024-07-04 18:59:13",
"classifyName": "标识关联关系图"
}]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
异常示例
json
{
"code": 106,
"message": "请求入参错误,{}"
}
1
2
3
4
2
3
4
标识数据列表
操作者通过此接口获取某个元数据模板下的标识列表。
请求参数
- 请求服务:企业节点业务系统 HTTP 端口(默认 3000)
- 请求方式:GET
- 请求路径:
/api/v1/open/handle/page
- Header:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
Authorization | String | 是 | - | Bearer + 空格 + token(身份接口获取) | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJz....... |
Content-Type | String | 是 | - | application/json | application/json |
- Query参数:
参数 | 类型 | 是否必填 | 最大长度 | 备注 | 示例值 |
---|---|---|---|---|---|
metaHandle | String | 是 | - | 元数据标识 | |
handleName | String | 否 | - | 实例标识 | |
startTime | String | 否 | - | 开始时间 yyyy-MM-dd HH:mm:ss | |
endTime | String | 否 | - | 结束时间 yyyy-MM-dd HH:mm:ss | |
page | Integer | 否 | - | 默认值0 | |
size | Integer | 否 | - | 默认值10 |
请求示例
json
/api/v1/open/handle/page?metaHandle="88.608.5288/META_06271012"&page=0&size=10
1
响应数据
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
code | Integer | 状态码(详见状态码说明) | 1 |
message | String | 状态码描述 | 成功 |
data | Object | 具体响应对象 |
- data 数据结构
参数 | 类型 | 备注 | 示例值 |
---|---|---|---|
handleName | String | 实例标识 | "" |
updateTime | String | 更新时间 | |
createdBy | String | 用户名/应用名 | |
createdTime | String | 创建时间 |
响应示例
json
{
"code": 1,
"message": "成功",
"data": {
"pageSize": 10,
"pageNumber": 1,
"totalCount": 1,
"totalPage": 1,
"content": [
{
"handleName": "88.608.5288/234242342",
"updateTime": "2024-07-08 17:15:53",
"createTime": "2024-07-08 17:15:53",
"createdBy": "用户名/应用名"
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
异常示例
json
{
"code": 106,
"message": "请求入参错误,{}"
}
1
2
3
4
2
3
4