Querying Service Ticket List Interface
Function Description
To query the interface of the service ticket list.
Debugging
You can debug this API in API Explorer.
URI
GET /v2/servicerequest/cases
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| search_key | No | Array | Queries keywords, separated by spaces. |
| label_id_list | No | Array | Specifies the label list, which contains a maximum of 5 labels. |
| app_key | No | String | Queries APP keywords. Minimum length: 0 Maximum length: 64 |
| incident_id | No | String | Specifies the service ticket ID. Minimum length: 0 Maximum length: 64 |
| query_start_time | No | String | Indicates the start time of the query. Minimum length: 0 Maximum length: 32 |
| query_end_time | No | String | Indicates the end time of the query. Minimum length: 0 Maximum length: 32 |
| status | No | Integer | Specifies the status. The values include: 0 (To be processed), 1 (Processing), 2 (To be confirmed), 3 (Completed), 4 (Canceled), 12 (Invalid), and 17 (Pending feedback). Minimum value: 0 Maximum value: 20 |
| incident_status | No | String | Specifies the status list. Minimum length: 0 Maximum length: 32 |
| x_customer_id | No | String | Specifies the sub-user ID. Minimum length: 0 Maximum length: 64 |
| x_customer_name | No | String | Specifies the sub-user name. Minimum length: 0 Maximum length: 64 |
| group_id | No | String | Specifies the group ID. Minimum length: 0 Maximum length: 64 |
| offset | No | Integer | Specifies the query offset. Minimum value: 0 Maximum value: 65535 |
| limit | No | Integer | Specifies the quantity limit of the query. Minimum value: 0 Maximum value: 100 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Specifies the user token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). Minimum length: 1 Maximum length: 5000 |
| X-Site | No | Integer | Specifies the site. The value can be 0 (China site) or 1 (International site). If this parameter is left blank, it is 0 by default. Minimum value: 0 Maximum value: 1 |
| X-Language | No | String | Specifies the language environment. The value is a common language description character string, for example, zh-cn. It is zh-cn by default. Some internationalization information, such as the service ticket type and name, is displayed based on the language environment. Minimum length: 1 Maximum length: 32 |
| X-Time-Zone | No | String | Specifies the time zone. The value is a common time zone description character string, for example, GMT+8. It is GMT+8 by default. Time-related data is processed based on the time zone of the environment. Minimum length: 1 Maximum length: 32 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| total_count | Integer | Specifies the total number. Minimum value: 0 Maximum value: 65535 |
| incident_info_list | Array of IncidentInfoV2 objects | Specifies the service ticket list. |
| Parameter | Type | Description |
|---|---|---|
| xcustomer_id | String | Specifies the sub-user ID. Minimum length: 0 Maximum length: 64 |
| xcustomer_name | String | Specifies the sub-user name. Minimum length: 0 Maximum length: 256 |
| status | Integer | Specifies the status. The values include: 0 (To be processed), 1 (Processing), 2 (To be confirmed), 3 (Completed), 4 (Canceled), 12 (Invalid), and 17 (Pending feedback). Minimum value: 0 Maximum value: 20 |
| incident_id | String | Specifies the service ticket ID. Minimum length: 0 Maximum length: 64 |
| business_type_name | String | Specifies the problem type name. Minimum length: 0 Maximum length: 64 |
| incident_type_name | String | Specifies the service ticket type name. Minimum length: 0 Maximum length: 64 |
| customer_id | String | Specifies the customer ID. Minimum length: 0 Maximum length: 64 |
| dc_name | String | Specifies the region name. Minimum length: 0 Maximum length: 64 |
| simple_description | String | A brief description. Minimum length: 0 Maximum length: 2000 |
| create_time | String | Specifies the creation time. |
| label_list | Array of LabelInfo objects | Specifies the label list. |
Request Example
None
Response Example
None
Status Code
| Status Code | Description |
|---|---|
| 200 | response of 200 |
Error Code
See here.
Last Article: Querying Associated Partner Service Information
Next Article: Querying Sub-User Information
Did this article solve your problem?
Thank you for your score!Your feedback would help us improve the website.