查询标签
功能介绍
查询标签
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/servicerequest/labels
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
查询偏移量,默认0 最小值:0 最大值:2147483647 |
limit |
否 |
Integer |
查询数量,默认10,最大100 最小值:0 最大值:100 |
name |
否 |
String |
标签名称,最大64,支持模糊查询 最小长度:0 最大长度:64 |
label_id |
否 |
Integer |
标签标识 最小值:0 最大值:2147483647 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度:1 最大长度:5000 |
X-Language |
否 |
String |
语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。 会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。 最小长度:1 最大长度:32 |
X-Time-Zone |
否 |
String |
环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。 涉及时间的数据会根据环境时区处理。 最小长度:1 最大长度:32 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Integer |
总数 最小值:0 最大值:2147483647 |
label_list |
Array of CaseLabelInfo objects |
标签列表 数组长度:0 - 2147483647 |
请求示例
GET https://{endpoint}/v2/servicerequest/labels?offset=0&limit=10 null
响应示例
状态码: 200
成功返回
{ "total_count" : 1, "label_list" : [ { "label_id" : 1, "name" : "test", "color" : "#000000" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
成功返回 |
错误码
请参见错误码。