标签画像OpenAPI

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

一、公共参数

1.1 响应格式

1.2 异常响应码

1.3 枚举列表

1.3.1 TagEnum

1.3.2 TagValueTypeEnum

1.3.3 TagPublishTypeEnum

1.3.4 TagUpdateModeEnum

1.3.5 SyncPeriodEnum

1.3.6 GroupSourceEnum

1.3.7 CalStatusEnum

1.3.8 TagPropFormTypeEnum

1.3.9 TagSubTypeEnum

1.3.10 TagPublicTypeEnum

1.3.11 TagStatusEnum

1.3.12 UseTypeEnum

1.3.13 SecurityLevelEnum

1.3.14 DataCategoryEnum

1.3.15 DataTypeEnum

1.4 通用数据结构

1.4.1 PageResult

分页查询结果

1.4.2 UserInfo

1.5 标签

1.5.1 TagSummary

标签概要

1.5.2 TagDetail

标签详情

1.5.3 TagPropValue

标签详情

1.5.4 TagSelect

标签简单信息

1.5.5 TagPropValueWithDesc

标签详情

1.6 类目

1.6.1 CatalogInfo

类目数据结构

1.6.2 DscDict

1.6.3 DscDictWithDesc

1.7 码表

1.7.1 TagAttributeInfo

码表数据结构

1.8 群组

1.8.1 GroupSummary

群组摘要数据结构

1.8.2 GroupPkgInfo

群组包相关数据结构

1.9 版本管理

1.9.1 HistoryVersionInfo

二、OpenAPI列表

2.1 OpenAPI总览

2.2 标签

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

POST /tag/v1/all-tag/list

产品版本：v3.1.2

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

URL参数/请求体

响应体

2.2.2 获取标签详情

POST /tag/v1/detail/get

产品版本：v3.1.2

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

URL参数/请求体

响应体

响应示例：

{

"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参数/请求体

响应体

响应示例：

{

"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参数/请求体

响应体

响应示例：

2.2.5 更新标签

POST /tag/v1/update

产品版本：v3.7.2

描述：更新标签（只有toUpdateFields中的字段才会进行更新，已发布态标签更新后需再次发布才能生效）

URL参数/请求体

Content-Type: application/json

请求示例：

{

"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": 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参数/请求体

响应体

响应示例：

{

"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参数/请求体

响应体

响应示例：

{

"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

}