5. 数据模板相关接口

5.1 列表

已添加的模板列表，每页固定大小10条

5.1.1 请求参数

请求服务：服务器的HTTP端口
请求方式: GET
请求路径：/api/template/list
Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token（身份接口获取）	XXXXX@@
Content-Type	String	是	-	application/json

Param：

参数	类型	是否必填	最大长度	备注	示例值
page	int	是	-	页码	1

5.1.2 请求示例

/api/template/list?page=1

5.1.3 响应参数

公共响应参数：

参数	类型	最大长度	备注	示例值
code	String	-	状态码	"000"
msg	String	-	状态码描述	"操作成功"
data	Object	-	返回数据格式

响应参数：

参数	类型	最大长度	备注	示例值
result	Array	-	数据
result[i].prefix	String	-	前缀	88.488.xxx
result[i].version	String	-	版本	2.0
result[i].type	String	-	元数据对象类型[枚举值: 1:主动标识载体、 2:其他]	1
result[i].create	String	-	创建时间	2023-05-31 16:59:35
pager	Object	-	页码信息
pager.page	int	-	页码	1
pager.pageSize	int	-	页码大小	10
pager.total	int	-	总数	1
pager.totalPage	int	-	总页数	1

5.1.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": {
    "result": [
      {
        "prefix": "88.488.xxx",
        "version": "2.0",
        "type": 1,
        "create": "2023-05-31 16:59:35"
      }
    ],
    "pager": {
      "page": 1,
      "pageSize": 10,
      "total": 1,
      "totalPage": 1
    }
  }
}

5.1.5 异常示例

{
  "code": "002",
  "succ": false,
  "msg": "token失效",
  "data": []
}

5.2 查询数据模板

数据模板查询接口用来查询已经建立的数据模板相关信息，用户可以通过此接口查询数据模板详细信息。

5.2.1 请求参数

请求服务：服务器的HTTP端口
请求方式：GET
请求路径：/api/template/query
Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param：

参数	类型	是否必填	最大长度	备注	示例值
version	String	是	128	模板版本	2.0

5.2.2 请求示例

/api/template/query?version=2.0

5.2.3 响应参数

公共响应参数

参数	类型	最大长度	备注	示例值
code	String	-	状态码	"000"
msg	String	-	状态码描述	"操作成功"
data	Object	-	返回数据格式

响应参数

参数	类型	最大长度	备注	示例值
prefix	String	-	前缀	88.488.xxx
version	String	-	模板版本	2.0
industryCategory	String	-	行业门类	A
industrySpecific	String	-	行业大类	01
industryTrade	String	-	行业中类	011
industrySubclass	String	-	行业小类	0111
type	Integer	-	元数据对象类型[枚举值: 1:主动标识载体、 2:其他]	1
description	String	-	描述	模板描述
items	Array	-	模板内容	-
items[i].name	String	-	中文名称	模板
items[i].idType	String	-	英文名称	ip
items[i].required	Boole	-	是否必填项	false
items[i].metadata	Array	-	数据限制	-
items[i].metadata.type	String	-	数据类型（现只支持String）	string
items[i].metadata.minLength	Int	-	最小长度	1
items[i].metadata.maxLength	Int	-	最大长度	10

5.2.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": {
    "prefix": "88.488.xxx",
    "version": "2.0",
    "description": "模板描述",
    "industryCategory": "A",
    "industrySpecific": "01",
    "industryTrade": "011",
    "industrySubclass": "0111",
    "type": 1,
    "items": [
      {
        "name": "产品名称",
        "idIndex": 2000,
        "idType": "name",
        "metadata": {
          "minLength": 1,
          "type": "string",
          "maxLength": 50
        },
        "required": true,
        "state": 1
      },
      {
        "name": "编号",
        "idIndex": 2001,
        "idType": "number",
        "metadata": {
          "minLength": 0,
          "type": "string",
          "maxLength": 30
        },
        "required": false,
        "state": 1
      }
    ]
  }
}

5.2.5 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "无符合条件的模板",
  "data": []
}

5.3 行业获取

5.3.1 请求参数

请求服务：服务器的HTTP端口
请求方式：GET
请求路径：/api/filter/industry
Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

5.3.2 请求示例

/api/filter/industry

5.3.3 响应参数

公共响应参数

参数	类型	最大长度	备注	示例值
code	String	-	状态码	"000"
msg	String	-	状态码描述	"操作成功"
data	Object	-	返回数据格式

响应参数

参数	类型	最大长度	备注	示例值
id	String	-	ID	"5000"
dictCode	String	-	行业标识	"A"
dictValue	String	-	行业门类	农、林、牧、渔业
parentId	String	-	父节点	0
children	Array	-	数组

5.3.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [
    {
      "id": "5000",
      "dictCode": "A",                //行业门类
      "dictValue": "农、林、牧、渔业",  //
      "parentId": 0,
      "children": [
        {
          "id": "5020",
          "dictCode": "01",      //行业大类
          "dictValue": "农业",
          "parentId": 5000,
          "children": [
              {
                "id": "15052",
                "dictCode": "011",    //行业中类
                "dictValue": "谷物种植",
                "parentId": 5020,
                "children": [
                  {
                    "id": "15563",
                    "dictCode": "0111",   //行业小类
                    "dictValue": "稻谷种植",
                    "parentId": 15052
                  },
                  {
                    "id": "15564",
                    "dictCode": "0112",
                    "dictValue": "小麦种植",
                    "parentId": 15052
                  },
    ....
}

5.3.5 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "sys err",
  "data": []
}

5.4 新增数据模板

5.4.1 请求参数

请求服务：服务器的HTTP端口
请求方式：POST
请求路径：/api/template/create
Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body:

参数	类型	是否必填	最大长度	备注	示例值
version	String	必填	-	模板版本	模板版本
industryCategory	String	必填	-	行业门类	A
industrySpecific	String	必填	-	行业大类	01
industryTrade	String	必填	-	行业中类	011
industrySubclass	String	必填	-	行业小类	0111
type	Integer	必填	-	元数据对象类型[枚举值: 1:主动标识载体、 2:其他]	1
description	String	非必填	-	描述	模板描述
items	Array	必填	-	模板内容	-
items[i].name	String	必填	-	中文名称	产品名称
items[i].idType	String	必填	-	英文名称	name
items[i].idIndex	int	必填	-	模板索引	2000
items[i].required	Boole	非必填	-	是否必填项	true
items[i].metadata	Array	必填	-	数据限制	-
items[i].metadata.type	String	非必填	-	数据类型（现只支持String）	string
items[i].metadata.minLength	Int	必填	-	最小长度	1
items[i].metadata.maxLength	Int	必填	-	最大长度	10

5.4.2 请求示例

{
  "version":"V10.0",
  "type":1,
  "description":"XXXXXXXXXXX",
  "industryCategory":"A",
  "industrySpecific":"01",
  "industryTrade":"011",
  "industrySubclass":"0111",
  "items": [
    {
      "name": "名称",
      "idType": "name",
      "idIndex": 2000,
      "required": true,
      "metadata": {
        "type": "string",
        "minLength": 1,
        "maxLength": 30
      }
    },
    {
      "name": "编号",
      "idType": "number",
      "idIndex": 2001,
      "required": false,
      "metadata": {
        "type": "string",
        "minLength": 0,
        "maxLength": 30
      }
    }
  ]
}

5.4.3 响应参数

参数	类型	最大长度	备注	示例值
code	String	-	状态码	"000"
msg	String	-	状态码描述	"操作成功"
succ	Boolean	-	成功状态	true

5.4.4 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

5.4.5 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "产品型号重复，不允许创建！",
  "data": []
}

5.4.6 注意事项

items[i].metadata.type必须为小写string。
items[i]. idIndex从2000开始, 2000 以内是系统保留索引。

5.5 删除数据模板

5.5.1 请求参数

请求服务：服务器的HTTP端口
请求方式：GET
请求路径: /api/template/del
Header:

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param:

参数	类型	是否必填	最大长度	备注	示例值
version	String	必填	128	模板版本	1.0.1

5.5.2 请求示例

/api/template/del?version=旺旺1.0

5.5.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

5.5.4 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "模板不存在",
  "data": []
}

5.6 修改数据模板

5.6.1 请求参数

请求服务：服务器的HTTP端口
请求方式：POST
请求路径：/api/template/update
Header：

参数	类型	是否必填	最大长度	备注	示例值
token	String	是	-	token(身份接口获取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

参数	类型	是否必填	最大长度	备注	示例值
version	String	必填	-	模板版本	1.0.1
industryCategory	String	必填	-	行业门类	A
industrySpecific	String	必填	-	行业大类	01
industryTrade	String	必填	-	行业中类	011
industrySubclass	String	必填	-	行业小类	0111
type	Integer	必填	-	元数据对象类型[枚举值: 1:主动标识载体、 2:其他]	1
description	String	非必填	-	描述	模板1.0.1
items	Array	必填	-	模板内容	-
items[i].name	String	必填	-	中文名称	模板
items[i].idType	String	必填	-	英文名称	ip
items[i].idIndex	Integer	必填	-	模板索引	2000
items[i].required	Boole	非必填	-	是否必填项	false
items[i].state	Integer	必填	-	模板属性状态	0-禁用，1-启用
items[i].metadata	Array	必填	-	数据限制	-
items[i].metadata.type	String	非必填	-	数据类型（现只支持String）	string
items[i].metadata.minLength	Int	必填	-	最小长度	1
items[i].metadata.maxLength	Int	必填	-	最大长度	10

5.6.2 请求示例

{
  "version":"模板版本",
  "type":1,
  "description":"模板描述",
  "industryCategory":"A",
  "industrySpecific":"01",
  "industryTrade":"011",
  "industrySubclass":"0111",
  "items": [
    {
      "name": "名称",
      "idType": "name",
      "idIndex": 2000,
      "required": true,
      "metadata": {
        "type": "string",
        "minLength": 1,
        "maxLength": 30
      },
      "state": 1
    }
  ]
}

5.6.3 响应示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": []
}

5.6.4 异常示例

{
  "code": "001",
  "succ": false,
  "msg": "操作失败！模板Index与英文名称对应不一致！",
  "data": []
}

5.6.5 注意事项

items[i].metadata.type必须为小写string。
修改操作，items[i].idIndex和items[i].idType必须匹配。
items[i].idIndex不传进行新增操作，items[i].idType不能重复。
items[i]. idIndex 2000 开始。

# 5. 数据模板相关接口

# 5.1 列表

# 5.1.1 请求参数

# 5.1.2 请求示例

# 5.1.3 响应参数

# 5.1.4 响应示例

# 5.1.5 异常示例

# 5.2 查询数据模板

# 5.2.1 请求参数

# 5.2.2 请求示例

# 5.2.3 响应参数

# 5.2.4 响应示例

# 5.2.5 异常示例

# 5.3 行业获取

# 5.3.1 请求参数

# 5.3.2 请求示例

# 5.3.3 响应参数

# 5.3.4 响应示例

# 5.3.5 异常示例

# 5.4 新增数据模板

# 5.4.1 请求参数

# 5.4.2 请求示例

# 5.4.3 响应参数

# 5.4.4 响应示例

# 5.4.5 异常示例

# 5.4.6 注意事项

# 5.5 删除数据模板

# 5.5.1 请求参数

# 5.5.2 请求示例

# 5.5.3 响应示例

# 5.5.4 异常示例

# 5.6 修改数据模板

# 5.6.1 请求参数

# 5.6.2 请求示例

# 5.6.3 响应示例

# 5.6.4 异常示例

# 5.6.5 注意事项

5. 数据模板相关接口

5.1 列表

5.1.1 请求参数

5.1.2 请求示例

5.1.3 响应参数

5.1.4 响应示例

5.1.5 异常示例

5.2 查询数据模板

5.2.1 请求参数

5.2.2 请求示例

5.2.3 响应参数

5.2.4 响应示例

5.2.5 异常示例

5.3 行业获取

5.3.1 请求参数

5.3.2 请求示例

5.3.3 响应参数

5.3.4 响应示例

5.3.5 异常示例

5.4 新增数据模板

5.4.1 请求参数

5.4.2 请求示例

5.4.3 响应参数

5.4.4 响应示例

5.4.5 异常示例

5.4.6 注意事项

5.5 删除数据模板

5.5.1 请求参数

5.5.2 请求示例

5.5.3 响应示例

5.5.4 异常示例

5.6 修改数据模板

5.6.1 请求参数

5.6.2 请求示例

5.6.3 响应示例

5.6.4 异常示例

5.6.5 注意事项