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

一、公共参数

1.1 响应格式

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

1.2 异常响应码

响应码 说明
1000
2000

1.3 枚举列表

1.3.1 TagEnum
枚举值 类型 名称
1 Number 基础标签
2 Number 行为标签
3 Number 复合标签
4 Number 人工标签
1.3.2 TagValueTypeEnum
枚举值 类型 名称
-1 Number 未知
0 Number 数值型
1 Number 文本型
2 Number 日期型
暂无 暂无 暂无
4 Number 枚举
5 Number 存储
1.3.3 TagPublishTypeEnum
枚举值 类型 名称
0 Number 未发布
1 Number 已发布
1.3.4 TagUpdateModeEnum
枚举值 类型 名称
1 Number 手动
2 Number 周期
3 Number 依赖
4 Number 实时
1.3.5 SyncPeriodEnum
枚举值 类型 名称
0 Number
1 Number 小时
2 Number
3 Number
4 Number
1.3.6 GroupSourceEnum
枚举值 类型 名称
1 Number 标签规则
2 Number 群组规则
3 Number 文件上传
1.3.7 CalStatusEnum
枚举值 类型 名称
0 Number 未开始
1 Number 就绪
2 Number 运行中
3 Number 成功
4 Number 失败
1.3.8 TagPropFormTypeEnum
枚举值 类型 名称
0 Number 文本
1 Number 枚举单选
2 Number 枚举多选
3 Number 布尔值
4 Number 层级单选
1.3.9 TagSubTypeEnum
枚举值 类型 名称 所属标签类型
0 Number 非标识 基础标签
1 Number 标识 基础标签
2 Number 主标识 基础标签
100 Number 行为主体属性 行为标签
101 Number 行为属性 行为标签
102 Number 行为对象属性 行为标签
103 Number 行为类型 行为标签
104 Number 行为度量 行为标签
201 Number 主键静态打标 人工标签
202 Number 逻辑动态打标 人工标签
300 Number 自定义标签值 复合标签
301 Number 首末次特征 复合标签
302 Number 指标计算 复合标签
303 Number SQL创建 复合标签
304 Number 事件偏好属性 复合标签
305 Number 时间间隔 复合标签
306 Number 维度筛选 复合标签
1.3.10 TagPublicTypeEnum
枚举值 类型 名称
1 Number 公开
2 Number 私有
3 Number 权限控制
1.3.11 TagStatusEnum
枚举值 类型 名称
0 Number 新建
1 Number 草稿
2 Number 已发布
3 Number 已下线
1.3.12 UseTypeEnum
枚举值 类型 名称
0 Number 任意引用
1 Number 开发模式引用
2 Number 线上模式引用
1.3.13 SecurityLevelEnum
枚举值 类型 名称
1 Number S1-低
2 Number S2-中
3 Number S3-高
4 Number S4-极高
1.3.14 DataCategoryEnum
枚举值 类型 名称
1 Number 编码类
2 Number 标志类
3 Number 代码类
4 Number 日期时间类
5 Number 数值类
6 Number 文本类
7 Number 文本枚举类
1.3.15 DataTypeEnum
枚举值 类型 名称
1 Number CHAR
2 Number VARCHAR2
3 Number DATE
4 Number DECIMAL
5 Number INTEGER
6 Number TIME
7 Number TIMESTAMP

1.4 通用数据结构

1.4.1 PageResult

分页查询结果

字段 类型 描述
pageSize Number 每页显示条数
pageNum Number 页数
totalCount Number 总条数
list Array<Object> 当前页结果
1.4.2 UserInfo
字段 类型 描述 是否必填 默认值
user String 邮箱
fullName String 名称

1.5 标签

1.5.1 TagSummary

标签概要

字段 类型 描述 是否必填 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
objectUid String 对象UID
objectName String 对象名称
objectCode String 对象标识
tagUid String 标签UID
tagName String 标签名称
tagCode String 标签标识
tagCodeAlias String 标签编码
description String 标签描述
catalogUid String 标签类目UID
catalogInfo CatalogInfo 标签类目信息
dscDicts Array<DscDict> 所属资源目录信息
tagType TagEnum 标签类型
tagSubType TagSubTypeEnum 标签子类型
updateMode TagUpdateModeEnum 更新方式
syncPeriod SyncPeriodEnum 更新周期
firstUpdateTime Number 首次更新时间
tagStatus TagStatusEnum 标签状态
creator UserInfo 创建人
createTime Number 创建时间
modifier UserInfo 最近修改人
updateTime Number 最近修改时间
valueType TagValueTypeEnum 标签值类型
db String 数据映射库
table String 数据映射表
fieldName String 数据映射字段
fieldType String 数据映射字段类型
publicType TagPublicTypeEnum 公开状态
tagPropValues Array<TagPropValue> 标签属性字段值列表
version Number 标签版本
publishReviewer UserInfo 发布人
offlineReviewer UserInfo 下线人
publishReviewTime Number 发布时间
offlineReviewTime Number 下线时间
governanced Boolean 是否已治理
1.5.2 TagDetail

标签详情

字段 类型 描述 是否必填 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
objectUid String 对象UID
objectName String 对象名称
objectCode String 对象标识
tagUid String 标签UID
tagName String 标签名称
tagCode String 标签标识
tagCodeAlias String 标签编码
description String 标签描述
catalogUid String 标签类目UID
catalogInfo CatalogInfo 标签类目信息
dscDicts Arraylt;DscDictWithDesc> 所属资源目录信息
tagType TagEnum 标签类型
tagSubType TagSubTypeEnum 标签子类型
updateMode TagUpdateModeEnum 更新方式
syncPeriod SyncPeriodEnum 更新周期
firstUpdateTime Number 首次更新时间
tagStatus TagStatusEnum 标签状态
creator UserInfo 创建人
createTime Number 创建时间
modifier UserInfo 最近修改人
updateTime Number 最近修改时间
valueType TagValueTypeEnum 标签值类型
db String 数据映射库
table String 数据映射表
fieldName String 数据映射字段
fieldType String 数据映射字段类型
attributes Array<TagAttributeInfo> 码表
publicType TagPublicTypeEnum 公开状态
tagPropValues Array<TagPropValueWithDesc> 标签属性字段值列表
version Number 标签版本
publishReviewer UserInfo 发布人
offlineReviewer UserInfo 下线人
publishReviewTime Number 发布时间
offlineReviewTime Number 下线时间
tagTypeDesc String 标签类型中文含义
tagSubTypeDesc String 标签子类型中文含义
valueTypeDesc String 标签值类型中文含义
publicTypeDesc String 公开状态中文含义
tagStatusDesc String 标签状态中文含义
updateModeDesc String 更新方式中文含义
syncPeriodDesc String 更新周期中文含义
detailPath String 详情页路径
governanced Boolean 是否已治理
1.5.3 TagPropValue

标签详情

字段 类型 描述 是否必填 默认值
uid String 标签属性字段唯一标识符
name String 属性字段名称
displayName String 属性字段显示名称
tagPropFromType TagPropFormTypeEnum 属性字段值类型
text String 文本类型值
singleEnum String 枚举单值
multiEnum Array<String> 枚举多值
boolValue Boolean 布尔值
singleLayer Object 层级单选(json object)
1.5.4 TagSelect

标签简单信息

字段 类型 描述 是否必填 默认值
uid String 标签属性字段唯一标识符
name String 属性字段名称
tagType TagEnum 标签类型
1.5.5 TagPropValueWithDesc

标签详情

字段 类型 描述 是否必填 默认值
uid String 标签属性字段唯一标识符
name String 属性字段名称
displayName String 属性字段显示名称
tagPropFromType TagPropFormTypeEnum 属性字段值类型
text String 属性字段值(文本类型值)
singleEnum String 属性字段值(枚举单值)
multiEnum Array<String> 属性字段值(枚举多值)
boolValue Boolean 属性字段值(布尔值)
singleLayer Object 属性字段值(层级单选(json object))
number String 属性字段值(数值型)
tagPropFromTypeDesc String 属性字段值类型名称
valueDesc Object 属性字段值名称(合并不同字段值类型,可直接使用该字段)

1.6 类目

1.6.1 CatalogInfo

类目数据结构

字段 类型 描述 是否必填 默认值
uid String 类目UID
parentUid String 父类目UID
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
name String 名称
description String 描述
children Array<CatalogInfo> 子类目列表
parent CatalogInfo 父类目
whitelist String 白名单,格式 aa@xx.com,bb@xx.com
1.6.2 DscDict
字段 类型 描述 是否必填 默认值
useType UseTypeEnum 使用类型
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
tagUid String 标签UID
dictIdentifier String 资源目录唯一标识
rootDictIdentifier
String 资源目录和标签的绑定关系节点所属根目录
dictSourceType Integer 资源目录来源:1 标签;2 数据标准
dictSourceTypeDesc String 资源目录来源名称
1.6.3 DscDictWithDesc
字段 类型 描述 是否必填 默认值
useType UseTypeEnum 使用类型
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
tagUid String 标签UID
dictIdentifier String 资源目录唯一标识
rootDictIdentifier String 资源目录和标签的绑定关系节点所属根目录
useTypeDesc String 使用类型名称
dictIdentifierDesc String 资源目录名称
rootDictIdentifierDesc String 资源目录和标签的绑定关系节点所属根目录名称
dictSourceType Integer 资源目录来源:1 标签;2 数据标准
dictSourceTypeDesc String 资源目录来源名称

1.7 码表

1.7.1 TagAttributeInfo

码表数据结构

字段 类型 描述 是否必填 默认值
uid String 码表UID
value String 标签值
expression String 码表对应译码表达式
description String 描述
creator UserInfo 创建人邮箱
modifier UserInfo 修改人邮箱

1.8 群组

1.8.1 GroupSummary

群组摘要数据结构

字段 类型 描述 是否必填 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
groupUid String 群组UID
groupName String 群组名称
description String 群组描述
objectUid String 对象UID
objectName String 对象名称
objectCode String 对象标识
updateWay TagUpdateModeEnum 更新方式(v3.2.0版本之后产品上改为群组类型,手动对应静态群组,周期对应动态群组,实时对应实时群组)
syncPeriod SyncPeriodEnum 更新周期
source GroupSourceEnum 群组创建方式
status CalStatusEnum 计算状态
coverage Number 覆盖数
dataUpdateTime Number 最近计算时间
popularity Number 热度
creator UserInfo 创建人
createTime Number 创建时间
modifier UserInfo 最近修改人
updateTime Number 最近修改时间
1.8.2 GroupPkgInfo

群组包相关数据结构

字段 类型 描述 是否必填 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
groupUid String 群组UID
calcId Number 计算ID
dimTagName String 标识名称
dimTagUid String 标识UID
status CalStatusEnum 计算状态
coverage Number 覆盖数
dataUpdateTime Number 计算时间
downloadPath String 数据下载地址
selectTagViews Array<TagSelect> 查询标签

1.9 版本管理

1.9.1 HistoryVersionInfo
字段 类型 描述 是否必填 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
tagUid String 标签UID
tagStatus TagStatusEnum 标签状态
publishReviewer UserInfo 发布人
offlineReviewer UserInfo 下线人
publishReviewTime Number 发布时间
offlineReviewTime Number 下线时间
version Number 标签版本
versionName String 标签版本名称

二、OpenAPI列表

2.1 OpenAPI总览

模块名称支持版本状态请求方法请求路径
标签

获取标签详情v3.1.2已上线POST /tag/v1/detail/get
获取标签列表v3.1.2已上线POST /tag/v1/all-tag/list
获取标签发布的历史版本信息v3.1.2GET
更新标签v3.7.2POST/tag/v1/update
群组获取群组列表v3.0.1已上线GET /group/v1/all-group/list
获取群组包列表v3.0.1已上线GET /group/v1/pkg-info/list

2.2 标签

2.2.1 获取标签列表(仅获取已发布标签)

POST /tag/v1/all-tag/list

产品版本:v3.1.2

描述:运营、MA等其他系统获取全部标签信息用于展示

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
objectUid String 对象UID
catalogUids Array<String> 类目UID
tagTypes Array<TagEnum> 标签类型
pageNum Number 页码 1
pageSize Number 分页大小 25

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result PageResult<TagSummary> 标签列表信息
2.2.2 获取标签详情

POST /tag/v1/detail/get

产品版本:v3.1.2

描述:运营、MA等其他系统获取全部标签信息用于展示

URL参数/请求体

名称 类型 描述 必须 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
tagUids Array<String> 标签UID
version Number 标签版本

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result Array<TagDetail> 标签详情

响应示例:

{

"code":0,

"action":0,

"msg":null,

"result":\[

    {

        "objId":319,

        "objectUid":"67973eb2bfd647d58b3170242c097df6",

        "objectName":"这是一个对象",

        "objectCode":"object",

        "tagUid":"5f35371a5acd4d059c588be4f81f379b",

        "tagName":"这是一个标签",

        "tagCode":"fieldCovert",

        "tagCodeAlias":"LB-B00011249",

        "description":"标签描述",

        "catalogUid":"56d61c36bbab482da1da4eccb4c5d6bc",

        "catalogInfo":{

        },

        "tagType":1,

        "tagSubType":2,

        "creator":{

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

            "fullName":"金雨鑫"

        },

        "createTime":1661743381000,

        "modifier":{

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

            "fullName":"金雨鑫"

        },

        "updateTime":1663752048000,

        "valueType":4,

        "db":"intern\_new",

        "table":"easytag\_demo\_ec\_user\_d",

        "fieldName":"user\_id",

        "fieldType":"string",

        "publicType":1,

        "updateMode":null,

        "syncPeriod":null,

        "firstUpdateTime":null,

        "tagStatus":2,

        "tagPropValues":\[

            {

                "id":null,

                "createTime":null,

                "updateTime":null,

                "uid":"9b480b8c89024a2d9f8ad0a270762f83",

                "pgId":null,

                "projectId":null,

                "clusterId":null,

                "creator":null,

                "modifier":null,

                "creatorDto":null,

                "modifierDto":null,

                "tagPropFromType":3,

                "text":null,

                "singleEnum":null,

                "multiEnum":null,

                "boolValue":true,

                "singleLayer":null,

                "timestamp":null,

                "number":null,

                "name":"测试一下布尔值",

                "displayName":"测试一下布尔值",

                "tagPropFromTypeDesc":"布尔值",

                "valueDesc":"是"

            },

            {

                "id":null,

                "createTime":null,

                "updateTime":null,

                "uid":"9b4f2b46a8e5417ca37b2f1a4f2775b6",

                "pgId":null,

                "projectId":null,

                "clusterId":null,

                "creator":null,

                "modifier":null,

                "creatorDto":null,

                "modifierDto":null,

                "tagPropFromType":2,

                "text":null,

                "singleEnum":null,

                "multiEnum":\[

                    "枚举1",

                    "枚举3"

                \],

                "boolValue":null,

                "singleLayer":null,

                "timestamp":null,

                "number":null,

                "name":"测试一下枚举多选",

                "displayName":"测试一下枚举多选",

                "tagPropFromTypeDesc":"枚举多选",

                "valueDesc":\[

                    "枚举1",

                    "枚举3"

                \]

            },

            {

                "id":null,

                "createTime":null,

                "updateTime":null,

                "uid":"bc70ad2699674a2fa83e26b170baf5d3",

                "pgId":null,

                "projectId":null,

                "clusterId":null,

                "creator":null,

                "modifier":null,

                "creatorDto":null,

                "modifierDto":null,

                "tagPropFromType":4,

                "text":null,

                "singleEnum":null,

                "multiEnum":null,

                "boolValue":null,

                "singleLayer":"8804-二级",

                "timestamp":null,

                "number":null,

                "name":"测试一下层级单选",

                "displayName":"测试一下层级单选",

                "tagPropFromTypeDesc":"层级单选",

                "valueDesc":"8804-二级"

            },

            {

                "id":null,

                "createTime":null,

                "updateTime":null,

                "uid":"securityLevel",

                "pgId":null,

                "projectId":null,

                "clusterId":null,

                "creator":null,

                "modifier":null,

                "creatorDto":null,

                "modifierDto":null,

                "tagPropFromType":1,

                "text":null,

                "singleEnum":"3",

                "multiEnum":null,

                "boolValue":null,

                "singleLayer":null,

                "timestamp":null,

                "number":null,

                "name":"安全等级",

                "displayName":"安全等级",

                "tagPropFromTypeDesc":"枚举单选",

                "valueDesc":"3-高"

            }

        \],

        "publishReviewer":{

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

            "fullName":"金雨鑫"

        },

        "offlineReviewer":null,

        "publishReviewTime":1663752048482,

        "offlineReviewTime":null,

        "version":3,

        "dscDicts":\[

            {

                "id":2186,

                "createTime":1663752028000,

                "updateTime":1663752028000,

                "uid":null,

                "pgId":null,

                "projectId":null,

                "clusterId":null,

                "creator":"jinyuxin@corp.netease.com",

                "modifier":"jinyuxin@corp.netease.com",

                "creatorDto":{

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

                    "name":"金雨鑫",

                    "displayName":"金雨鑫(jinyuxin@corp.netease.com)"

                },

                "modifierDto":{

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

                    "name":"金雨鑫",

                    "displayName":"金雨鑫(jinyuxin@corp.netease.com)"

                },

                "useType":2,

                "objId":319,

                "tagUid":"5f35371a5acd4d059c588be4f81f379b",

                "dictIdentifier":"SFXX",

                "rootDictIdentifier":"OBJ",

                "name":"对象类别",

                "fullPath":"/人员信息/身份信息",

                "useTypeDesc":"线上模式引用",

                "dictIdentifierDesc":"身份信息",

                "rootDictIdentifierDesc":"对象类别"

            }

        \],

        "tagTypeDesc":"基础标签",

        "tagSubTypeDesc":"主标识",

        "valueTypeDesc":"枚举型",

        "publicTypeDesc":"公开",

        "tagStatusDesc":"已发布",

        "updateModeDesc":null,

        "syncPeriodDesc":null,

        "attributes":\[\],

        "detailPath":"/easydmp/tag/tagdetail?tagUid=5f35371a5acd4d059c588be4f81f379b&product=mammut\_demo&clusterId=hz8&modelId=319&version=1&historyModel=1"

    }

\],

"reqId":"d349dc0f99cb49da925fc1eee84a5c30-nbot115.dg.163.org",

"cost":49

}

2.2.3 获取标签发布的历史版本信息

GET /tag/v1/version/list

产品版本:v3.1.2

描述:用于获取某个标签的历史版本信息

URL参数/请求体

名称 类型 描述 必须 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
tagUid String 标签UID

响应体

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时
msg String 响应消息
result Array<HistoryVersionInfo> 标签版本信息

响应示例:

{

"code": 0,

"action": 0,

"msg": null,

"result": \[

    {

        "objId": 278,

        "tagUid": "d7e0c74c54cf4a25926bd64d7628ad9b",

        "tagStatus": 1,

        "publishReviewer": null,

        "offlineReviewer": null,

        "publishReviewTime": null,

        "offlineReviewTime": null,

        "version": 2,

        "versionName": "v2"

    },

    {

        "objId": 278,

        "tagUid": "d7e0c74c54cf4a25926bd64d7628ad9b",

        "tagStatus": 2,

        "publishReviewer": {

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

            "fullName": "金雨鑫"

        },

        "offlineReviewer": null,

        "publishReviewTime": 1653635164859,

        "offlineReviewTime": null,

        "version": 1,

        "versionName": "v1"

    }

\],

"reqId": "904dfa553a244dccae690172bb0ad368-jinyxdeMacBook-Pro.local",

"cost": 3334

}

2.2.4 获取标签列表(获取全部标签)

POST /tag/v1/dev/all-tag/list

产品版本:v3.1.2

描述:用于获取某个标签的历史版本信息

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
objectUid String 对象UID
catalogUids Array<String> 类目UID
tagTypes Array<TagEnum> 标签类型
tagStatuses Array<TagStatusEnum> 标签状态
pageNum Number 页码 1
pageSize Number 分页大小 25

响应体

名称 类型 描述
code Number 响应码
reqId String 请求ID
cost Number 耗时
msg String 响应消息
result PageResult<TagSummary> 标签版本信息

响应示例:

2.2.5 更新标签

POST /tag/v1/update

产品版本:v3.7.2

描述:更新标签(只有toUpdateFields中的字段才会进行更新,已发布态标签更新后需再次发布才能生效)

URL参数/请求体

Content-Type: application/json

字段 类型 字段名称 描述 是否必填 默认值
toUpdateFields List<String> 需要更新的字段列表(字段名称,系统字段+自定义字段)(若自定义字段在toUpdateFields中存在,但在customInfo中不存在,表示删除该自定义字段值;同理,若系统字段在toUpdateFields中存在,但没有传或者传null,表示清除该系统字段值) 空集合(不更新)
toUpdateDirectories List<String> 需要更新的资源目录列表(标签自定义目录+标准目录)(若资源目录在toUpdateCatalogs中存在,但在customCatalogInfo中不存在,表示删除该资源目录值) 空集合(不更新)
groupId Number 项目组ID
clusterId String 集群ID
objId Number 工作组ID
tagUid String 标签uid(唯一标识)
user String 操作用户邮箱(1-64个字符)
product String 项目名
name String 标签名称 标签名称(1-64个字符)
tagCode String 标签标识 标签标识(1-128个字符)
publicType Number 公开属性 公开属性(详见[TagPublicTypeEnum])
description String 标签描述 标签描述
catalogPath String 标签类目 标签类目全路径(如 一级目录/二级目录)
securityLevel Number 安全等级 安全等级(详见[SecurityLevelEnum])
competentDept String 主管部门 主管部门
businessOwner String 业务负责人 业务负责人邮箱
dataAnalyst String 数据分析师 数据分析师邮箱
businessCaliber String 业务口径 业务口径
businessRule String 业务规则 业务规则
formulateBasis String 制定依据 制定依据
physicalName String 物理名称 物理名称
dataCategory Number 数据类别 数据类别(详见[DataCategoryEnum])
dataType Number 数据类型 数据类型(详见[DataTypeEnum])
dataLength String 数据长度 数据长度
dataPrecision String 数据精度 数据精度
dataFormat String 数据格式 数据格式
measureUnit String 度量单位 度量单位
valueRange String 取值范围 取值范围
technicalCaliber String 技术口径 技术口径
customInfo Map<String, Object> 自定义字段信息(key 字段名称,value 值)
directoryInfo Map<String, String> 标签自定义目录+标准目录(key为一级目录名称,value为节点全路径,如 一级目录/二级目录)

请求示例:

{

"toUpdateFields":\["标签名称","标签描述","自定义字段1"\],

"toUpdateDirectories":\["资源目录1","资源目录2"\],

"tagUid":"TAG54e1b8bd884c402ca23f3ae27b595870",

"groupId":44,

"product""intern",

"clusterId":"dev4",

"objId":1,

"user":"admin.netease.com",

"name":"test",

"tagCode":"tagCode",

"publicType":1,

"description":"标签描述",

"catalogPath":"一级目录/二级目录",

"securityLevel":1,

"competentDept":"开发部",

"businessOwner":"admin.netease.com",

"dataAnalyst":"admin.netease.com",

"businessCaliber":"businessCaliber",

"businessRule":"businessRule",

"formulateBasis":"formulateBasis",

"physicalName":"physicalName",

"dataCategory":1,

"dataType":1,

"dataLength":"dataLength",

"dataPrecision":"dataPrecision",

"dataFormat":"dataFormat",

"measureUnit":"measureUnit",

"valueRange":"valueRange",

"technicalCaliber":"technicalCaliber",

"customInfo":{

    "自定义文本型1":"test",

    "自定义布尔型1":false,

    "自定义枚举单选型1":"选项1",

    "自定义枚举多选型1":\["选项1","选项2"\],

    "自定义层级单选型1":"一级节点/二级节点"

},

"directoryInfo":{

    "资源目录1":"资源目录1/二级节点",

    "资源目录2":"资源目录2/二级节点"

}

}

响应体

名称 类型 描述 必传 默认值
code Number 状态码
msg String 错误信息
cost Number 接口消耗毫秒数
reqId String 请求ID
result Boolean 是否更新成功,为true时表示更新成功

响应示例:

{

"code": 0,

"cost": 10,

"reqId": "3b35310c3b024366b5600e66872214f5",

"msg": null,

"result": true

}

2.3 群组

2.3.1 获取群组列表

GET /group/v1/all-group/list

产品版本:v3.1.2

描述:运营、MA等其他系统获取全部群组用于展示和选择

URL参数/请求体

名称 类型 描述 必须 默认值
groupId Number 项目组ID
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
objectUids Array<String> 对象UID
pageNum Number 页码 1
pageSize Number 分页大小 25

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result PageResult<GroupSummary> 群组列表信息

响应示例:

{

"code": 0,

"action": 0,

"msg": null,

"result": {

    "pageNum": 1,

    "pageSize": 25,

    "totalCount": 1,

    "list": \[

        {

            "objId": 292,

            "groupUid": "96a061f48b534828ba120d9a0a752668",

            "groupName": "你好我是群组01",

            "description": "",

            "objectUid": "ccf6e7ad360a444caa8bf8ae0cce88c7",

            "objectName": "我是对象名称",

            "objectCode": "objectCode\_1",

            "updateWay": 1,

            "syncPeriod": 0,

            "source": 1,

            "status": 4,

            "coverage": 0,

            "dataUpdateTime": 1655897785000,

            "popularity": 0,

            "creator": {

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

                "fullName": "金雨鑫"

            },

            "createTime": 1655897785000,

            "modifier": {

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

                "fullName": "金雨鑫"

            },

            "updateTime": 1655897785000

        }

    \]

},

"reqId": "bc0d6563435b4dd0bebf185f5f15cef5-jinyxdeMacBook-Pro.local",

"cost": 3582

}

2.3.2 获取群组数据

GET /group/v1/pkg-info/list

产品版本:v3.1.2

描述:运营、MA等其他系统主动来拉取群组包数据用于推送等场景

URL参数/请求体

名称 类型 描述 必须 默认值
objId Number 工作组ID(v3.2.0版本之前叫模型ID)
groupUid String 群组UID(群组详情页面中叫群组ID)

响应体

名称 类型 描述
code number 响应码
reqId string 请求ID
cost number 耗时
msg string 响应消息
result Array<GroupPkgInfo> 结果

响应示例:

{

"code": 0,

"action": 0,

"msg": null,

"result": \[

    {

        "objId": 279,

        "groupUid": "b0c1e52c84ef48f0abc93a643da69166",

        "calcId": 1004244,

        "dimTagUid": "d5ef0f9fc653478fb4c6b05e51b02d2a",

        "primaryTag": true,

        "dimTagName": "用户ID",

        "status": 3,

        "coverage": 846,

        "bizTime": 1655308800000,

        "dataUpdateTime": 1655372047000,

        "dataCreateTime": 1655372030000,

        "pkg": true,

        "downloadPath": "http://easytag-dev.service.163.org/et/api/openapi-v4/group/v1/pkg/download?objId=279&groupUid=b0c1e52c84ef48f0abc93a643da69166&calcIds=1004244",

        "groupName": "年龄小于100的群组",

        "selectTagViews": \[

            {

                "uid": "8099ed91be894665b3d9ad4374e23f96",

                "name": "性别",

                "tagType": 1

            }

        \]

    }

\],

"reqId": "8b1396adf7bd44af8927a4a20e7f5132-jinyxdeMacBook-Pro.local",

"cost": 1372

}