数据中心客户端对接文档

对接鉴权

客户端需要使用OAUTH客户端模式的方式请求数据中心的接口。对接的客户端id和密钥请联系信息化开发部。

客户端对接

客户端需要提供修改回调的API和API接口地址，回调接口开放权限，回调接口会提醒客户端变更的数据，客户端自行重新请求对应的数据获取数据的更新。
完成请将客户端和对应的地址提供给信息化开发部。

客户端提供的API

Method : POST

URL : *

Auth required : False

body

  1. {
  2.   "id": "1234",
  3.   "code": "gNT4IZHmaptirbUZCwu",
  4.   "type": "FIELD",
  5.   "operationType": "UPDATE"
  6. }

请求参数

参数名称 参数说明 请求类型 是否必须 默认值 限制 数据类型
id 这次修改的消息唯一标识 body true 非空 string
code 这次修改的数据的唯一标识 body true 非空 string
type 改动的类型 body true {FIELD: 字段, FILED_VALUE: 字段值} string
operationType 操作的类型 body true {ADD: 添加, UPDATE: 更新, DEL: 删除} string

返回示例

成功返回http状态值为200即可

客户端使用到的API

注意：有些属性暂无使用场景，API中没有列出。

Base URL

[http://192.168.10.35:80/api/v3](http://192.168.10.35:80/api/v3)

特殊说明

查询特定语言数据通过Accept-Language设置，放在Headers或者Request Params中，不传值默认语言为中文

优先级
Request Params > Headers

路由

🔒 = 需要鉴权

方案

字段信息

字段值信息

字段值信息

API 详情

当前客户端方案

Method : GET

URL : {{baseUrl}}/scheme/current

Auth required : True

返回示例

  1.     "success": true,
  2.     "msg": "查询成功",
  3.     "code": 0,
  4.     "data": {
  5.         "code": "1",
  6.         "keyCode": "test",
  7.         "cnName": "test",
  8.         "enName": "test",
  9.         "name": "test",
  10.         "createBy": "0",
  11.         "fields": [
  12.             {
  13.                 "code": "gNT4IZHmaptirbUZCwu",
  14.                 "keyCode": "chips",
  15.                 "cnName": "平台型号",
  16.                 "enName": "Chip platform model",
  17.                 "name": "平台型号",
  18.                 "cnDescription": "",
  19.                 "enDescription": "",
  20.                 "description": "",
  21.                 "dataType": "STRING",
  22.                 "fieldType": "LIST",
  23.                 "sort": 1,
  24.                 "createBy": "0",
  25.                 "permissions": {
  26.                     "addOperation": "Y",
  27.                     "editOperation": "Y",
  28.                     "delOperation": "Y"
  29.                 }
  30.             },
  31.             {
  32.                 "code": "jZvXRZ6OZLColB4AE5l",
  33.                 "keyCode": "product",
  34.                 "cnName": "产品线",
  35.                 "enName": "Product",
  36.                 "name": "产品线",
  37.                 "cnDescription": "",
  38.                 "enDescription": "",
  39.                 "description": "",
  40.                 "dataType": "STRING",
  41.                 "fieldType": "TREE",
  42.                 "sort": 1,
  43.                 "createBy": "0",
  44.                 "permissions": {
  45.                     "addOperation": "Y",
  46.                     "editOperation": "Y",
  47.                     "delOperation": "Y"
  48.                 }
  49.             }
  50.         ]
  51.     }

返回参数

参数名称 参数说明 数据类型
code 方案编码 string
keyCode 方案key string
name 方案名称 string
fields 方案包含字段信息 array
 code 字段编码 string
 keyCode 字段key string
 name 名称(根据语言展示) string
 description 描述(根据语言展示) string
 dataType 数据类型 { STRING: 字符串, NUM: 数字 } string
 fieldType 字段类型 { LIST: 列表, TREE: 树 } string
 permissions 字段的权限 object
  addOperation 添加权限 {Y: 有权限, N: 无权限} string
  editOperation 编辑权限 {Y: 有权限, N: 无权限} string
  delOperation 删除权限 {Y: 有权限, N: 无权限} string

查询字段基本信息

Method : GET

URL : {{baseUrl}}/field

Auth required : True

Request Params

参数名称 参数说明 请求类型 是否必须 默认值 限制 数据类型
code 编码 Request Params true 编码 string
type 编码类型 Request Params true {KEY: 特定key的编码, CODE: 随机编码格式} string

返回示例

  1. {
  2.   "success": true,
  3.   "msg": null,
  4.   "code": 0,
  5.     "data": {
  6.         "code": "jZvXRZ6OZLColB4AE5l",
  7.         "keyCode": "product",
  8.         "cnName": "产品线",
  9.         "enName": "Product",
  10.         "name": "产品线",
  11.         "cnDescription": "",
  12.         "enDescription": "",
  13.         "description": "",
  14.         "dataType": "STRING",
  15.         "fieldType": "TREE",
  16.         "sort": 1,
  17.         "createBy": "0",
  18.         "allowValues": [
  19.             {
  20.                 "code": "0NHat5RpR8Fx7psH53a",
  21.                 "parentCode": "0",
  22.                 "fieldCode": "jZvXRZ6OZLColB4AE5l",
  23.                 "cnValue": "LTE",
  24.                 "enValue": "LTE",
  25.                 "value": "LTE",
  26.                 "cnDescription": "",
  27.                 "enDescription": "",
  28.                 "description": "",
  29.                 "sort": 1,
  30.                 "createBy": "0",
  31.                 "children": []
  32.             },
  33.             {
  34.                 "code": "0VvNVKhYtbS9OwL8m1p",
  35.                 "parentCode": "0",
  36.                 "fieldCode": "jZvXRZ6OZLColB4AE5l",
  37.                 "cnValue": "GNSS",
  38.                 "enValue": "GNSS",
  39.                 "value": "GNSS",
  40.                 "cnDescription": "",
  41.                 "enDescription": "",
  42.                 "description": "",
  43.                 "sort": 1,
  44.                 "createBy": "0",
  45.                 "children": []
  46.             }
  47.         ],
  48.         "permissions": {
  49.             "addOperation": "Y",
  50.             "editOperation": "Y",
  51.             "delOperation": "Y"
  52.         }
  53.     }
  54. }

返回参数

参数名称 参数说明 数据类型
code 字段编码 string
keyCode 字段key string
name 名称(根据语言展示) string
description 描述(根据语言展示) string
dataType 数据类型 { STRING: 字符串, NUM: 数字 } string
fieldType 字段类型 { LIST: 列表, TREE: 树 } string
allowValues 字段取值列表 array
 code 字段值编码 string
 parentCode 字段值父编码 string
 fieldCode 所属字段编码 string
 value 取值 string
 description 描述 string
 children 孩子取值列表 array
permissions 字段的权限 object
 addOperation 添加权限 {Y: 有权限, N: 无权限} string
 editOperation 编辑权限 {Y: 有权限, N: 无权限} string
 delOperation 删除权限 {Y: 有权限, N: 无权限} string

查询字段值的基本信息

Method : GET

URL : {{baseUrl}}/field/value/:fieldValueCode

URL Parameters : fieldValueCode=[string] fieldValueCode 表单值的编码

Auth required : True

返回示例

  1. {
  2.     "success": true,
  3.     "code": 0,
  4.     "data": {
  5.         "code": "5RMq8CfqdiY5Xm6AGxl",
  6.         "parentCode": "0",
  7.         "fieldCode": "6dY62c13NCxAoyEV4iB",
  8.         "cnValue": "软件部",
  9.         "enValue": "software department",
  10.         "value": "软件部",
  11.         "cnDescription": "描述",
  12.         "enDescription": "description",
  13.         "description": "描述"
  14.     }
  15. }

返回参数

参数名称 参数说明 数据类型
code 字段编码 string
parentCode 父编码 string
fieldCode 字段编码 string
value 值 string
description 描述 string

查询字段值信息

Method : POST

URL : {{baseUrl}}/value/filter

Auth required : True

body

  1. {
  3.     "fieldKey": "projectCategory",
  4.     "filters": [
  5.         {
  6.             "relFieldKey": "product",
  7.             "propertyValues": ["SEZJDWAyrdTo1jsOejA"]
  8.         }
  9.     ]
  10. }
参数名称 参数说明 请求类型 是否必须 默认值 限制 数据类型
fieldKey 字段key body true 字段key string
filters 过滤的条件 body true 数组 string
 relFieldKey 关联字段key body true 字段key string
 propertyValues 关联字段值 body true 字段值数组 string