查询工单列表接口
功能介绍
查询工单列表接口
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/servicerequest/cases
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search_key |
否 |
Array |
关键字查询，支持多个空格隔开 数组长度：0 - 32 |
|
label_id_list |
否 |
Array |
标签列表，最多支持5个 数组长度：0 - 5 |
|
app_key |
否 |
String |
app关键字查询 最小长度：0 最大长度：64 |
|
incident_id |
否 |
String |
工单id 最小长度：0 最大长度：64 |
|
query_start_time |
否 |
String |
查询开始时间 最小长度：0 最大长度：32 |
|
query_end_time |
否 |
String |
查询结束时间 最小长度：0 最大长度：32 |
|
status |
否 |
Integer |
状态 0：待受理 1：处理中 2：待确认结果 3：已完成 4：已撤销 12：无效 17： 待反馈 最小值：0 最大值：20 |
|
incident_status |
否 |
String |
状态列表 最小长度：0 最大长度：32 |
|
x_customer_id |
否 |
String |
子用户id 最小长度：0 最大长度：64 |
|
x_customer_name |
否 |
String |
子用户名称 最小长度：0 最大长度：64 |
|
group_id |
否 |
String |
组id 最小长度：0 最大长度：64 |
|
offset |
否 |
Integer |
查询偏移量 最小值：0 最大值：65535 |
|
limit |
否 |
Integer |
查询限制数量 最小值：0 最大值：100 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
总数 最小值：0 最大值：65535 |
|
incident_info_list |
Array of IncidentInfoV2 objects |
工单列表 数组长度：0 - 65535 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
xcustomer_id |
String |
子用户id 最小长度：0 最大长度：64 |
|
xcustomer_name |
String |
子用户名称 最小长度：0 最大长度：256 |
|
status |
Integer |
状态 0：待受理 1：处理中 2：待确认结果 3：已完成 4：已撤销 12：无效 17： 待反馈 最小值：0 最大值：20 |
|
incident_id |
String |
工单id 最小长度：0 最大长度：64 |
|
business_type_name |
String |
问题类型名称 最小长度：0 最大长度：64 |
|
incident_type_name |
String |
工单类型名称 最小长度：0 最大长度：64 |
|
customer_id |
String |
客户id 最小长度：0 最大长度：64 |
|
dc_name |
String |
区域名称 最小长度：0 最大长度：64 |
|
simple_description |
String |
简要描述 最小长度：0 最大长度：2000 |
|
create_time |
String |
创建时间 |
|
label_list |
Array of LabelInfo objects |
标签列表 数组长度：0 - 5 |
请求示例
无
响应示例
状态码： 200
response of 200
{
"total_count" : 1,
"incident_info_list" : [ {
"xcustomer_id" : "test",
"xcustomer_name" : "test",
"status" : 0,
"incident_id" : "test",
"business_type_name" : "test",
"incident_type_name" : "test",
"customer_id" : "test",
"dc_name" : "test",
"simple_description" : "test",
"create_time" : "test",
"label_list" : [ {
"label_id" : 1,
"name" : "test",
"color" : "test"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
response of 200 |
错误码
请参见错误码。
