On this page

Show all

Help Center/ Service Tickets/ API Reference/ API v2 (Recommended)/ Ticket Query/ Querying Service Ticket Details

Querying Service Ticket Details

Updated on 2022-12-12 GMT+08:00

View PDF

Function

Query the details of a service ticket.

URI

GET /v2/servicerequest/cases/{case_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
case_id	Yes	String	Specifies the service ticket ID. Minimum length: 1 Maximum length: 64

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
group_id	No	String	Specifies the group ID. Minimum length: 0 Maximum length: 64

Request Parameters

**Table 3** Request header 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-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

**Table 4** Response body parameters
Parameter	Type	Description
incident_detail_info	IncidentDetailInfoV2 object	Describes the service ticket details.

**Table 5** IncidentDetailInfoV2
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 options are 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
judgment	String	Indicates the evaluation content. Minimum length: 0 Maximum length: 400
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
source_name	String	Specifies the source name. Minimum length: 0 Maximum length: 64
create_time	String	Specifies the creation time. Minimum length: 0 Maximum length: 32
message_list	Array of IncidentMessageV2 objects	Specifies the list of messages.
incident_satisfaction	Array of IncidentSatisfactionV2Do objects	Specifies the satisfaction list.
is_authorized	Integer	Specifies whether it is authorized or not. Minimum value: 0 Maximum value: 1
severity_name	String	Specifies the severity name. Minimum length: 0 Maximum length: 64
business_ownership	Integer	To which it belongs. The options are 0 (Huawei Cloud), 1 (Partner), and 2 (ISV). Minimum value: 0 Maximum value: 2
resolve_time	Long	Specifies the resolution time. Minimum value: 0 Maximum value: 9223372036854775807
ext_info	IncidentDetailExtInfoV2 object

**Table 6** IncidentMessageV2
Parameter	Type	Description
type	Integer	Type. The options are 0 (Customer message) and 1 (Huawei engineer message). Minimum value: 0 Maximum value: 1
replier	String	Specifies the replier ID. Minimum length: 0 Maximum length: 64
content	String	Specifies the message content. Minimum length: 0 Maximum length: 5000
message_id	String	Specifies the message ID. Minimum length: 0 Maximum length: 64
replier_name	String	Specifies the replier name. Minimum length: 0 Maximum length: 256
create_time	String	Specifies the creation time. Minimum length: 0 Maximum length: 32
is_first_message	Integer	Specifies whether it is the first message. Minimum value: 0 Maximum value: 1
accessory_list	Array of SimpleAccessoryV2 objects	Specifies the attachment list.

**Table 7** SimpleAccessoryV2
Parameter	Type	Description
accessory_id	String	Specifies the attachment ID. Minimum length: 0 Maximum length: 64
file_actual_name	String	Specifies the actual name of the attachment. Minimum length: 0 Maximum length: 256

**Table 8** IncidentSatisfactionV2Do
Parameter	Type	Description
value	Integer	Specifies the total score of satisfaction. Minimum value: 0 Maximum value: 65535
satisfaction_id	Integer	Specifies the satisfaction category ID. Minimum value: 0 Maximum value: 9999
satisfaction_value	Integer	Specifies the satisfaction value. Minimum value: 0 Maximum value: 65535
satisfaction_name	String	Specifies the satisfaction category name. Minimum length: 0 Maximum length: 32
per_value	Integer	Specifies the score of a scale. Minimum value: 0 Maximum value: 65535
sat_category_id	String	Specifies the satisfaction dimension ID. Minimum length: 0 Maximum length: 32
sat_category_name	String	Specifies the satisfaction dimension name. Minimum length: 0 Maximum length: 32

**Table 9** IncidentDetailExtInfoV2
Parameter	Type	Description
area_code	String	Specifies the country/region code. Minimum length: 0 Maximum length: 16
remind_mobile	String	Indicates the notification receiving mobile phone. Minimum length: 0 Maximum length: 32
remind_mail	String	Indicates the notification receiving email address. Minimum length: 0 Maximum length: 256
contact_type	String	Indicates the contact method type. Minimum length: 0 Maximum length: 1
remind_time	String	Indicates the time when the notification is sent. Minimum length: 0 Maximum length: 32
cc_email	String	Indicates the Cc email address. Minimum length: 0 Maximum length: 5000
commodity_id	String	Indicates the ISV product ID. Minimum length: 0 Maximum length: 64

Request Example

None

Response Example

Status code: 200

Response of status code 200

{
  "incident_detail_info" : {
    "incident_id" : "123",
    "business_type_name" : "123",
    "incident_type_name" : "123",
    "customer_id" : "123",
    "xcustomer_id" : "123",
    "xcustomer_name" : "123",
    "dc_name" : "123",
    "simple_description" : "123",
    "status" : 1,
    "judgment" : "123",
    "message_list" : [ {
      "type" : 0,
      "replier" : "test",
      "message_id" : "test",
      "content" : "test",
      "replier_name" : "test",
      "create_time" : "test",
      "is_first_message" : 0,
      "accessory_list" : [ {
        "accessory_id" : "test",
        "file_actual_name" : "test"
      } ]
    } ],
    "incident_satisfaction" : [ {
      "value" : 1,
      "satisfaction_value" : 1,
      "satisfaction_id" : 1,
      "satisfaction_name" : "test",
      "per_value" : 1,
      "sat_category_id" : "test",
      "sat_category_name" : "test"
    } ],
    "is_authorized" : 1,
    "severity_name" : "test",
    "business_ownership" : 1,
    "resolve_time" : "test",
    "ext_info" : [ {
      "area_code" : "test",
      "remind_mobile" : "test",
      "remind_mail" : "test",
      "contact_type" : "test",
      "remind_time" : "test",
      "cc_email" : "test",
      "commodity_id" : "test"
    } ],
    "source_name" : "123",
    "create_time" : "123"
  }
}

Status Codes

Status Code	Description
200	Response of status code 200

Error Codes

See Error Codes.

Parent topic: Ticket Query

Previous topic: Statistics of Service Tickets in Various Statuses

Next topic: Querying Service Ticket Operation Logs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot