此手册用于记录大数据开发与管理平台中，数据标准产品所有对外开放的OpenAPI，阅读此手册，你将了解数据标准产品开放的OpenAPI能力与调用方法。

一、公共参数

1.1 响应格式

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时，单位：ms
msg String 响应消息
result Object 响应结果

1.2 异常响应码

响应码 说明
-1 系统异常
-2 请求参数错误

1.3 枚举列表表示词

1.3.1 ReferTypeEnum

关联类型

枚举值 类型 名称
easy_map String 表
easy_index String 指标
easy_tag String 标签
1.3.2 DictTypeEnum
枚举值 类型 名称
STANDARD String 标准字典
ORIGINAL String 原始字典

1.4 基础实体

1.4.1 PageResult

分页查询结果

字段 类型 描述
pageSize Number 每页显示条数
pageNum Number 页数
totalCount Number 总条数
totalPage Number 总页数
list Array<Object> 当前页结果
1.4.2 User

用户信息

字段 类型 描述
user String 账号邮箱
fullName String 用户名

1.5 词根

1.5.1 WordRoot

词根信息

字段 类型 描述
identifier String 标识符
name String 中文全称
nameFullEn String 英文全称
nameEn String 英文简称
source String 来源
description String 备注
1.5.2 WordRootTranslateResult

词根翻译结果

字段 类型 描述
nameEns Array<String> 翻译得到的英文简称列表
nameFullEns Array<String> 翻译得到的英文全称列表

1.6 资源目录

1.6.1 DataDirectoryInfo
字段 类型 描述
identifier String 目录编码
name String 目录名称
description String 备注
required Boolean 是否必填
referInfo Map<ReferTypeEnum, Integer> 引用详情表，键为引用类型，值为引用数量
1.6.2 DataDirectory

资源目录树

字段 类型 描述
info DataDirectoryInfo 目录当前节点信息
children Array<DataDirectory> 当前目录子节点

1.7 字典

1.7.1 UserSimpleInfo
字段 类型 描述
email String 邮箱
fullName String 用户名
1.7.2 DictValue
字段 类型 描述
code String 代码
description String 代码描述
remark String 描述
1.7.3 Map
字段 类型 描述
key String 实际值
value String 展示值
1.7.4 OpenDictDetailVO

字典详情信息

字段 类型 描述
id Number 字典id
name String 字典名称
nameEn String 英文名称
identifier String 字典标识
nameFullEn String 英文全称
classification String 分类
type String 类型
version String 版本
description String 备注
status String 状态
referenceBasis String 参考依据
creator UserSimpleInfo 创建人
dirId String 目录id
dictValues Array<DictValue> 字典值
dirTreePath String 以“/”分割的完整路径
custom Map 自定义属性
createTime String 字典创建时间,yyyy-mm-dd

二、OpenAPI列表

2.1 OpenAPI总览

模块名称支持版本状态请求方法请求路径
词根
查询词根列表v1.4.0已上线GET /word-root/v1/list
中文翻译v1.4.0已上线GET /word-root/v1/translate
资源目录查询资源目录树v1.3.1已上线GET /data-directory/v1/tree/list
字典批量分类v2.1.2已上线POST /dict/v1/category/batch/update
字典详情查询v2.1.2已上线GET /dict/v1/get
创建字典目录v2.1.4测试中POST /dict/v1/dir/add

2.2 词根API

2.2.1 查询词根列表

GET /word-root/v1/list

产品版本：v1.4.0

描述：查询数据标准中词根列表

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是
pageSize Number 每页显示条数，最多100条 否 25
pageNum Number 当前页码 否 1

请求示例：

curl -X GET http://easy-openapi.example.com/openapi/easystandard/word-root/v1/list?groupId=1&user=user@aa.com&pageSize=25&pageNum=1

请求示例：

?groupId=1&user=user@aa.com&pageSize=25&pageNum=1

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result PageResult<WordRoot> 词根列表 是 无

响应示例：


{

  "code": 0,

  "reqId": "54798",

  "cost": 133,

  "msg": "success",

  "result": {

    "PageSize": 25,

    "pageNum": 1,

    "totalCount": 1,

    "totalPage": 1,

    "list": \[

      {

        "identifier": "ETM00002",

        "name": "游戏",

        "nameFullEn": "game",

        "nameEn": "game",

        "source": "体育竞技",

        "description": "专业术语"

      }

    \]

  }

}
2.2.2 中文翻译

GET /word-root/v1/translate

产品版本：v1.4.0

描述：根据词根进行中文翻译

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是
text String 翻译原文 是 无

请求示例：

curl -X GET http://easy-openapi.example.com/openapi/easystandard/word-root/v1/translate/list?groupId=1&user=user@aa.com&text=原文

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result WordRootTranslateResult<WordRootTranslateResult> 中文翻译结果 是 无

响应示例：


{

  "code": 0,

  "reqId": "79797",

  "cost": 828,

  "msg": "success",

  "result": {

    "nameEns": \[

      "gm"

    \],

    "nameFullEns": \[

      "game"

    \]

  }

}

2.3 资源目录API

2.3.1 查询资源目录树

GET /data-directory/v1/tree/list

产品版本：v1.3.1

描述：查询数据标准中的资源目录树

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是 无

请求示例：

curl -X GET http://easy-openapi.example.com/openapi/easystandard/data-directory/v1/tree/list?groupId=1&user=user@aa.com

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result Array<DataDirectory> 资源目录树 是 无

响应示例：


{

  "code": 0,

  "reqId": "79622",

  "cost": 199,

  "msg": "success",

  "result": \[

    {

      "info": {

        "identifier": "OBJ",

        "name": "对象类别",

        "description": "对象分属类别",

        "required": false,

        "referInfo": {

            "easy\_map":0,

            "easy\_tag":0,

            "easy\_index":0

        }

      },

      "children": \[

        {

          "info": {

            "identifier": "WPXX",

            "name": "物品信息",

            "description": "物品所有信息",

            "required": false,

            "referInfo": {

                "easy\_map":0,

                "easy\_tag":0,

                "easy\_index":0

            }

          }

        }

      \]

    }

  \]

}

2.4 字典API

2.4.1 批量分类

POST dict/v1/category/batch/update

产品版本：v2.1.2

描述：批量更新字典分类

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是
identifiers Array<String> 字典内部标识符列表 是
dirPath String 字典目录路径，“/”相隔，例如/甲/乙/丙。“/”表示顶级目录 是
type DictTypeEnum 字典类型 是 无

请求示例：


{

  "identifiers": \["CD-B00000942", "CD-B00000945", "CD-B00000944"\],

  "dirPath": "/原始字典/原始分类/二级分类",

  "groupId": 65,

  "user": "yanxian01@corp.netease.com",

  "type": "ORIGINAL"

}

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result Boolean 结果（result=false为部分内部标识符不存在未更新，
result=true为全部更新）		 是 无

响应示例：


{

"code": 0,

"result": true,

"reqId": "f9b8a1cf1bc746da9d643ae729485b38",

"cost": 250

}
2.4.2 字典详情查询

GET dict/v1/get

产品版本：v2.1.2

描述：查询字典详细信息

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是
identifier String 字典标识符 是
type DictTypeEnum 字典类型 是 无

请求示例：

curl -X GET http://easy-openapi.example.com/openapi/easystandard/dict/v1/get?identifier=CD-B00000942&groupId=65&user=yanxian01@corp.netease.com&type=STANDARD


{

"identifier":"CD-B00000942",

"groupId":65,

"user":"yanxian01@corp.netease.com",

"type":"STANDARD"

}

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result OpenDictDetailVO 结果 是 无

响应示例：


{

"code": 0,

\-"result": {

"id": 1655,

"name": "id\_cn",

"nameEn": "CDB00000946",

"nameFullEn": "CDB00000946",

"identifier": "CD-B00000946",

"classification": "id\_cn",

"type": "ORIGINAL",

"description": "元数据导入自动创建",

"version": "1.0.0",

"status": "ADDITION",

\-"creator": {

"email": "yangmin06@corp.netease.com",

"fullName": "杨敏"},

"dirId": 65,

\-"dictValues": \[

\-{

"code": "1",

"description": "2"},

\-{

"code": "3",

"description": "4"}\],

"dirTreePath": "原始字典/默认分类",

"createTime": "2023-08-10 14:13:29"},

"reqId": "6e5878ad99ea4f7190bdc1889237b901",

"cost": 335}
2.4.3 创建字典目录

POST dict/v1/dir/add

产品版本：v2.1.4

描述：创建字典目录

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID 是
user String 用户邮箱 是
parentDirPath String 字典目录路径，“/”相隔，例如/甲/乙/丙。“/”为根目录 是
name String 新目录名称 是
type DictTypeEnum 字典类型 是 无

请求示例：


{

  "groupId": 65,

  "parentDirPath": "/原始分类",

  "name": "新目录",

  "type": "ORIGINAL",

  "user":"user"

}

响应体

名称 类型 描述 必传 默认值
code Number 状态码 是
msg String 错误信息 是
cost Number 接口消耗毫秒数 是
reqId String 请求ID 是
result Boolean 结果 是 无

响应示例：


{

"code": 0,

"msg":null,

"result": true,

"reqId": "f9b8a1cf1bc746da9d643ae729485b38",

"cost": 252

}