版本：3.3-SNAPSHOT

标签接口

标签开放接口

获取标签实例（枚举值）信息

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/getLabelInstance
Ø 请求示例：
{
	"labelField": "",
	"labelId": 0,
	"pageNo": 0,
	"pageSize": 0，
"bizWorkspaceName": "BNC"
}
Ø 请求参数:

参数名称	参数说明	是否必填	数据类型
labelField	标签字段	false	String
labelId	标签ID	true	integer(int32)
pageNo	页码	false	integer(int32)
pageSize	页大小	false	integer(int32)
bizWorkspaceName	业务体系名称	true	String

Ø 响应示例：
{
"data": {
"current": 1,
"total": 8,
"size": 10,
"lastPageNo": 0,
"list": [
{
"instanceName": "湖北",
"instanceValue": "0"
},
{
"instanceName": "湖南",
"instanceValue": "0"
}
]
},
"success": false,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}
Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
current	当前页码	integer(int64)
lastPageNo	最后一页面页码	integer(int64)
instanceName	标签实例名称	string
instanceValue	标签实例值	string
size	单页大小	integer(int64)
total	总记录数	integer(int64)
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

2.2、获取标签列表信息

支持分页和搜索，前期只对洞察类标签开放

Ø 请求方式:POST

Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/list

Ø 请求示例：

{
	"labelType": 0,
	"pageNo": 0,
	"pageSize": 0,
	"searchKey": "",
"bizWorkspaceName": "BNC"
}

请求参数:

参数名称	参数说明	是否必填	数据类型
labelType	标签类型，1:统计类标签，2：接口类标	true	String
searchKey	搜索关键字，可根据标签名，只支持右%号搜索	false	String
pageNo	页码	false	integer(int32)
pageSize	页大小	false	integer(int32)
bizWorkspaceName	业务体系名称	true	String

Ø 响应示例：

{
"data": {
"current": 1,
"total": 3,
"size": 10,
"lastPageNo": 0,
"list": [
{
"labelId": 28,
"labelField": "cdp_city",
"labelName": "接口类标签测试001",
"status": 5
},
{
"labelId": 29,
"labelField": "cdp_gender",
"labelName": "接口标签测试002",
"status": 5
},
{
"labelId": 32,
"labelField": "zxxz",
"labelName": "zxzx",
"status": 5
}
]
},
"success": false,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}
Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
current	当前页码	integer(int64)
lastPageNo	最后一页面页码	integer(int64)
labelField	标签字段	string
labelId	标签id	integer(int32)
labelName	标签名称	string
status	标签状态1:草稿, 2:需求 , 3:研发 , 4:测试 , 5:上线 , 6:下线	integer(int32)
size	单页大小	integer(int64)
total	总记录数	integer(int64)
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

标签（接口类标签）打标接口

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/set
Ø 请求示例：
{
"bizWorkspaceName": "BNC",
	"labelDetail": [
		{
			"key": 0,
			"labelValue": ""
		}
	],
	"labelField": "",
	"labelId": 0
}

请求参数:

参数名称	参数说明	是否必填	数据类型
key	用户唯一标识（HHID）	true	string
labelValue	更新标签值	true	string
labelField	标签字段名	true	String
labelId	标签ID	true	integer(int32)
bizWorkspaceName	业务体系名称	true	String

Ø 响应示例：
{
"data": null,
"success": false,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}
Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

创建标签接口

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/create
Ø 请求示例：
新增标签：	
{
"bizWorkspaceName": "BNC",
"labelId": null,
"labelName": "对外开放接口标签测试",
"labelNameEn": "label_open_test",
"labelCategoryCode": null,
"markingWay": null,
"labelBusinessDefinition": "对外开放接口标签创建",
"definitionDataType": 1,
"cdpUserOrgCode": "dev001",
"cdpUserGroupId": 1,
"cdpUserId": 1,
"cdpUserName": "wwd",
"status": 2,
"remark": null,
"labelInstances": [
{
"labelInstanceId": null,
"labelId": null,
"instanceName": "ss",
"instanceValue": null,
"enumValues": "ss",
}
]
}
编辑标签：
{
"bizWorkspaceName": "BNC",
"labelId": 101010,
"labelName": "对外开放接口标签测试",
"labelNameEn": "label_open_test",
"labelCategoryCode": null,
"markingWay": null,
"labelBusinessDefinition": "对外开放接口标签创建",
"definitionDataType": 1,
"cdpUserOrgCode": "dev001",
"cdpUserGroupId": 1,
"cdpUserId": 1,
"cdpUserName": "wwd",
"status": 4,
"remark": null,
"labelInstances": [
{
"labelInstanceId": null,
"labelId": null,
"instanceName": "ss",
"instanceValue": null,
"enumValues": "ss",
}
]
}

请求参数:

参数名称	参数说明	是否必填	数据类型
bizWorkspaceName	业务体系名称,例如:ANC,BNC	true	string
labelId	标签ID	false	integer(int32)
labelName	标签名称（编辑模式下不修改）	true	string
labelNameEn	标签字段名（编辑模式下不修改）	true	string
labelCategoryCode	标签分类code	true	String(100)
markingWay	标签标记类型 1:统计类标签， 2:接口类标签	true	string
labelBusinessDefinition	标签业务口径定义	true	string
definitionDataType	标签定义数据类型，1：文本、 2：整数、 3：浮点数， 4：日期、 5：日期时间	true	integer
cdpUserOrgCode	租户code	true	string
cdpUserGroupId	用户组ID	true	integer
cdpUserId	用户ID	true	integer
cdpUserName	用户名称	true	string
status	标签任务状态， 1：草稿、 2：已发布、 3：研发中、 4：测试中、 5：已上线， 6：已下线	true
remark	备注	false	string
labelInstanceId	标签枚举实例ID	false	Integer(int32)
instanceName	枚举实例名称	true	string
instanceValue	枚举实例映射值,0，1，2,...	false	integer
enumValues	枚举值	true	string

Ø 响应示例：

{
"data": 101010,
"success": true,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}
Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

根据hhid查询标签

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/getLabelAndValueListByHhid
Ø 请求示例：
{
"bizWorkspaceName":"BNC",
"hhid":"10033"
}	

请求参数:

参数名称	参数说明	是否必填	数据类型
bizWorkspaceName	业务体系名称,例如:ANC,BNC	true	string
hhid	HHID	true	string

Ø 响应示例：

{
"data": [
{
"labelName": "接口类标签测试001",
"labelValue": "湖南"
}
],
"success": true,
"code": "",
"msg": null,
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}

Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T
labelName	标签名称	string
labelValue	标签值	string

删除标签

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/delete
Ø 请求示例：
{
"bizWorkspaceName": "BNC",
"labelId":1
}	

请求参数:

参数名称	参数说明	是否必填	数据类型
labelId	标签ID	true	integer
bizWorkspaceName	业务体系名称	true	String

Ø 响应示例：
{
"data": null,
"success": true,
"code": "",
"msg": "操作成功",
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}

Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

根据hhid删除标签对应值

Ø 请求方式:POST
Ø 请求URL:/cdp-label-open-hh/oapi/v1/label/deleteLabelValueByHhid
Ø 请求示例：
{
"bizWorkspaceName": "BNC",
"labelId":1,
"hhidList":["10133"]
}

请求参数:
参数名称	参数说明	是否必填	数据类型
labelId	标签ID	true	integer
hhidList	hhid集合	true	arryList
bizWorkspaceName	业务体系名称	true	String
Ø 响应示例：
{
"data": null,
"success": true,
"code": "",
"msg": "操作成功",
"requestUrl": null,
"errorMsg": null,
"errorDetails": null,
"elapsed": 0,
"responseStatus": 200
}

Ø 响应参数：

参数名称	参数说明	数据类型
code	错误码	string
elapsed	请求响应耗时	integer(int64)
msg	消息提示信息	string
requestUrl	请求路径	string
success	操作标识	boolean
responseStatus	响应状态	int
errorDetails	错误堆栈信息	string
errorMsg	错误简短信息	string
data	返回数据	T

获取标签实例（枚举值）信息​

标签（接口类标签）打标接口​

创建标签接口​

根据hhid查询标签​

删除标签​

根据hhid删除标签对应值​

获取标签实例（枚举值）信息

标签（接口类标签）打标接口

创建标签接口

根据hhid查询标签

删除标签

根据hhid删除标签对应值