5. 數據模板相關(guān)接口

5.1 列表

已添加的模板列表，每頁(yè)固定大小10條

5.1.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式: GET
請求路徑：/api/template/list
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token（身份接口獲?。?/td>	XXXXX@@
Content-Type	String	是	-	application/json

Param：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
page	int	是	-	頁(yè)碼	1

5.1.2 請求示例

/api/template/list?page=1

5.1.3 響應參數

公共響應參數：

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	"000"
msg	String	-	狀態(tài)碼描述	"操作成功"
data	Object	-	返回數據格式

響應參數：

參數	類(lèi)型	最大長(cháng)度	備注	示例值
result	Array	-	數據
result[i].prefix	String	-	前綴	88.488.xxx
result[i].version	String	-	版本	2.0
result[i].type	String	-	元數據對象類(lèi)型[枚舉值: 1:主動(dòng)標識載體、 2:其他]	1
result[i].create	String	-	創(chuàng )建時(shí)間	2023-05-31 16:59:35
pager	Object	-	頁(yè)碼信息
pager.page	int	-	頁(yè)碼	1
pager.pageSize	int	-	頁(yè)碼大小	10
pager.total	int	-	總數	1
pager.totalPage	int	-	總頁(yè)數	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 查詢(xún)數據模板

數據模板查詢(xún)接口用來(lái)查詢(xún)已經(jīng)建立的數據模板相關(guān)信息，用戶(hù)可以通過(guò)此接口查詢(xún)數據模板詳細信息。

5.2.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑：/api/template/query
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
version	String	是	128	模板版本	2.0

5.2.2 請求示例

/api/template/query?version=2.0

5.2.3 響應參數

公共響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	"000"
msg	String	-	狀態(tài)碼描述	"操作成功"
data	Object	-	返回數據格式

響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
prefix	String	-	前綴	88.488.xxx
version	String	-	模板版本	2.0
industryCategory	String	-	行業(yè)門(mén)類(lèi)	A
industrySpecific	String	-	行業(yè)大類(lèi)	01
industryTrade	String	-	行業(yè)中類(lèi)	011
industrySubclass	String	-	行業(yè)小類(lèi)	0111
type	Integer	-	元數據對象類(lèi)型[枚舉值: 1:主動(dòng)標識載體、 2:其他]	1
description	String	-	描述	模板描述
items	Array	-	模板內容	-
items[i].name	String	-	中文名稱(chēng)	模板
items[i].idType	String	-	英文名稱(chēng)	ip
items[i].required	Boole	-	是否必填項	false
items[i].metadata	Array	-	數據限制	-
items[i].metadata.type	String	-	數據類(lèi)型（現只支持String）	string
items[i].metadata.minLength	Int	-	最小長(cháng)度	1
items[i].metadata.maxLength	Int	-	最大長(cháng)度	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": "產(chǎn)品名稱(chēng)",
        "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": "無(wú)符合條件的模板",
  "data": []
}

5.3 行業(yè)獲取

5.3.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑：/api/filter/industry
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

5.3.2 請求示例

/api/filter/industry

5.3.3 響應參數

公共響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	"000"
msg	String	-	狀態(tài)碼描述	"操作成功"
data	Object	-	返回數據格式

響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
id	String	-	ID	"5000"
dictCode	String	-	行業(yè)標識	"A"
dictValue	String	-	行業(yè)門(mén)類(lèi)	農、林、牧、漁業(yè)
parentId	String	-	父節點(diǎn)	0
children	Array	-	數組

5.3.4 響應示例

{
  "code": "000",
  "succ": true,
  "msg": "操作成功",
  "data": [
    {
      "id": "5000",
      "dictCode": "A",                //行業(yè)門(mén)類(lèi)
      "dictValue": "農、林、牧、漁業(yè)",  //
      "parentId": 0,
      "children": [
        {
          "id": "5020",
          "dictCode": "01",      //行業(yè)大類(lèi)
          "dictValue": "農業(yè)",
          "parentId": 5000,
          "children": [
              {
                "id": "15052",
                "dictCode": "011",    //行業(yè)中類(lèi)
                "dictValue": "谷物種植",
                "parentId": 5020,
                "children": [
                  {
                    "id": "15563",
                    "dictCode": "0111",   //行業(yè)小類(lèi)
                    "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 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/template/create
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
version	String	必填	-	模板版本	模板版本
industryCategory	String	必填	-	行業(yè)門(mén)類(lèi)	A
industrySpecific	String	必填	-	行業(yè)大類(lèi)	01
industryTrade	String	必填	-	行業(yè)中類(lèi)	011
industrySubclass	String	必填	-	行業(yè)小類(lèi)	0111
type	Integer	必填	-	元數據對象類(lèi)型[枚舉值: 1:主動(dòng)標識載體、 2:其他]	1
description	String	非必填	-	描述	模板描述
items	Array	必填	-	模板內容	-
items[i].name	String	必填	-	中文名稱(chēng)	產(chǎn)品名稱(chēng)
items[i].idType	String	必填	-	英文名稱(chēng)	name
items[i].idIndex	int	必填	-	模板索引	2000
items[i].required	Boole	非必填	-	是否必填項	true
items[i].metadata	Array	必填	-	數據限制	-
items[i].metadata.type	String	非必填	-	數據類(lèi)型（現只支持String）	string
items[i].metadata.minLength	Int	必填	-	最小長(cháng)度	1
items[i].metadata.maxLength	Int	必填	-	最大長(cháng)度	10

5.4.2 請求示例

{
  "version":"V10.0",
  "type":1,
  "description":"XXXXXXXXXXX",
  "industryCategory":"A",
  "industrySpecific":"01",
  "industryTrade":"011",
  "industrySubclass":"0111",
  "items": [
    {
      "name": "名稱(chēng)",
      "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 響應參數

參數	類(lèi)型	最大長(cháng)度	備注	示例值
code	String	-	狀態(tài)碼	"000"
msg	String	-	狀態(tài)碼描述	"操作成功"
succ	Boolean	-	成功狀態(tài)	true

5.4.4 響應示例

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

5.4.5 異常示例

{
  "code": "001",
  "succ": false,
  "msg": "產(chǎn)品型號重復，不允許創(chuàng  )建！",
  "data": []
}

5.4.6 注意事項

items[i].metadata.type必須為小寫(xiě)string。
items[i]. idIndex從2000開(kāi)始, 2000 以?xún)仁窍到y保留索引。

5.5 刪除數據模板

5.5.1 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：GET
請求路徑: /api/template/del
Header:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Param:

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
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 請求參數

請求服務(wù)：服務(wù)器的HTTP端口
請求方式：POST
請求路徑：/api/template/update
Header：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
token	String	是	-	token(身份接口獲取)	eli5I...dRg@
Content-Type	String	是	-	application/json	application/json

Body：

參數	類(lèi)型	是否必填	最大長(cháng)度	備注	示例值
version	String	必填	-	模板版本	1.0.1
industryCategory	String	必填	-	行業(yè)門(mén)類(lèi)	A
industrySpecific	String	必填	-	行業(yè)大類(lèi)	01
industryTrade	String	必填	-	行業(yè)中類(lèi)	011
industrySubclass	String	必填	-	行業(yè)小類(lèi)	0111
type	Integer	必填	-	元數據對象類(lèi)型[枚舉值: 1:主動(dòng)標識載體、 2:其他]	1
description	String	非必填	-	描述	模板1.0.1
items	Array	必填	-	模板內容	-
items[i].name	String	必填	-	中文名稱(chēng)	模板
items[i].idType	String	必填	-	英文名稱(chēng)	ip
items[i].idIndex	Integer	必填	-	模板索引	2000
items[i].required	Boole	非必填	-	是否必填項	false
items[i].state	Integer	必填	-	模板屬性狀態(tài)	0-禁用，1-啟用
items[i].metadata	Array	必填	-	數據限制	-
items[i].metadata.type	String	非必填	-	數據類(lèi)型（現只支持String）	string
items[i].metadata.minLength	Int	必填	-	最小長(cháng)度	1
items[i].metadata.maxLength	Int	必填	-	最大長(cháng)度	10

5.6.2 請求示例

{
  "version":"模板版本",
  "type":1,
  "description":"模板描述",
  "industryCategory":"A",
  "industrySpecific":"01",
  "industryTrade":"011",
  "industrySubclass":"0111",
  "items": [
    {
      "name": "名稱(chēng)",
      "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與英文名稱(chēng)對應不一致！",
  "data": []
}

5.6.5 注意事項

items[i].metadata.type必須為小寫(xiě)string。
修改操作，items[i].idIndex和items[i].idType必須匹配。
items[i].idIndex不傳進(jìn)行新增操作，items[i].idType不能重復。
items[i]. idIndex 2000 開(kāi)始。

# 5. 數據模板相關(guān)接口

# 5.1 列表

# 5.1.1 請求參數

# 5.1.2 請求示例

# 5.1.3 響應參數

# 5.1.4 響應示例

# 5.1.5 異常示例

# 5.2 查詢(xún)數據模板

# 5.2.1 請求參數

# 5.2.2 請求示例

# 5.2.3 響應參數

# 5.2.4 響應示例

# 5.2.5 異常示例

# 5.3 行業(yè)獲取

# 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. 數據模板相關(guān)接口

5.1 列表

5.1.1 請求參數

5.1.2 請求示例

5.1.3 響應參數

5.1.4 響應示例

5.1.5 異常示例

5.2 查詢(xún)數據模板

5.2.1 請求參數

5.2.2 請求示例

5.2.3 響應參數

5.2.4 響應示例

5.2.5 異常示例

5.3 行業(yè)獲取

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 注意事項