6.标签分类管理
6.1 新增标签分类接口
接口说明
为应用方增加标签分类,用于后续标签分类管理。
访问方式
URL |
编码方式 |
协议 |
method |
Content-Type |
/tagGroup/add |
Utf-8 |
https |
POST |
application/json |
Curl e.g.: curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tagGroup/add Request body e.g.: { "name": "guangzhou", "type":"city" } Response body e.g.: http status 200: { "result": 0, "desc": "成功", } 业务异常: { "result": xxx, "desc": "xxx" } http status 500: Internet server error! |
||||
接口定义
输入参数:
属性名字 |
类型 |
是否必填Y/N |
描述 |
name |
string |
Y |
标签分类名称 |
type |
int |
Y |
标签分类类型:1是普通标签,2是互斥标签 |
desc |
string |
N |
标签分类描述 |
输出参数:
属性名字 |
类型 |
描述 |
result |
int |
接口调用是否成功的状态码 0成功,非0失败 |
desc |
string |
文字描述接口调用情况 |
6.2 更新单个标签分类接口
接口说明
更新一个标签分类的信息,包括标签分类名称和描述。
访问方式
URL |
编码方式 |
协议 |
method |
Content-Type |
/tagGroup/update |
Utf-8 |
https |
POST |
application/json |
Curl e.g.: curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tagGroup/update Request body e.g.: { "oldName": "city", "newName": "province", "desc": "这是更新后的描述" } Response body e.g.: http status 200: { "result": 0, "desc": "成功" } 业务异常: { "result": xxx, "desc": "xxx" } http status 500: Internet server error! |
||||
接口定义
输入参数:
属性名字 |
类型 |
是否必填Y/N |
描述 |
oldName |
string |
Y |
旧标签分类名称 |
newName |
string |
Y |
新标签分类名称 |
desc |
string |
N |
新标签分类的描述 |
输出参数:
属性名字 |
类型 |
描述 |
result |
int |
接口调用是否成功的状态码 0成功,非0失败 |
desc |
string |
文字描述接口调用情况 |
6.3 添加标签到标签分类接口
接口说明
把标签添加进标签分类里面,一次可添加一个或者多个标签,最多不超过100个。
访问方式
URL |
编码方式 |
协议 |
method |
Content-Type |
/tagGroup/addToGroup |
Utf-8 |
https |
POST |
application/json |
Curl e.g.: curl -X POST -H 'authToken:${your_auth_token}' -H 'Content-Type:application/json' -d '${your_request_body}' https://host:port/tagGroup/addToGroup Request body e.g.: { "name":"city", "tagList":["shenzhen","guangzhou"] } Response body e.g.: http status 200: { "result": 0, "desc": "成功" } 业务异常: { "result": xxx, "desc": "xxx" } http status 500: Internet server error! |
||||
接口定义
输入参数:
属性名字 |
类型 |
是否必填Y/N |
描述 |
name |
string |
Y |
标签分类名称 |
tagList |
JSON Array |
Y |
一个或多个标签 |
输出参数:
属性名字 |
类型 |
描述 |
result |
int |
接口调用是否成功的状态码 0成功,非0失败 |
desc |
string |
文字描述接口调用情况 |

评论列表