Querying Incident Ticket Details

Function

This API is used to query incident ticket details.

URI

GET /v1/external/incident/{incident_num}

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
incident_num	Yes	String	Incident ticket ID Minimum length: 0 character Maximum length: 255 characters

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID. Default value: 049 Minimum length: 3 characters Maximum length: 100,000,000 characters
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Default value: GOM.00000000 Minimum length: 1 character Maximum length: 100,000,000 characters
error_msg	String	Request response description. Minimum length: 0 character Maximum length: 100,000,000 characters
data	IncidentTicketInfoResponseData object	data

**Table 3** IncidentTicketInfoResponseData
Parameter	Type	Description
incident_num	String	Incident ticket ID Minimum length: 0 character Maximum length: 255 characters
region	Array of strings	Region code. This parameter is mandatory if a WarRoom is automatically started. Currently, only one region code is supported. Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1 characters
enterprise_project	Array of strings	Enterprise project ID. Currently, only one enterprise project ID is supported. Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1 characters
current_cloud_service	Array of strings	Home application ID. Currently, only one home application ID is supported. Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1 characters
incident_level	String	Incident level. For details about the incident level, see Incident Level. Minimum length: 0 character Maximum length: 255 characters
is_service_interrupt	Boolean	Whether the service is interrupted. The value can be true or false. The value can be: true false
incident_type	String	Incident type. For details about the event type, see Incident Type. Minimum length: 0 character Maximum length: 255 characters
incident_title	String	Incident title. The value contains a maximum of 200 characters. Minimum length: 0 character Maximum length: 200 characters
incident_description	String	Incident description. The value can contain a maximum of 600 characters. Minimum length: 0 character Maximum length: 600 characters
incident_source	String	Incident source. For details about the incident source, see Incident Source. Minimum length: 0 character Maximum length: 255 characters
incident_assignee	Array of strings	Owner Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1 characters
assignee_scene	String	Schedule scenario Minimum length: 0 character Maximum length: 255 characters
assignee_role	String	Schedule role Minimum length: 0 character Maximum length: 255 characters
warroom_id	String	warroom_id Minimum length: 0 character Maximum length: 255 characters
handle_time	Long	Timestamp of the latest solution submission. Minimum value: 1 Maximum value: 9999999999
status	String	Status key. For details, see Incident Status. Minimum length: 0 character Maximum length: 255 characters
create_time	Long	Timestamp for ticket creation Minimum value: 0 Maximum value: 999999999
creator	String	Ticket creator Minimum length: 0 character Maximum length: 255 characters
enum_data_list	Array of TicketInfoEnumData objects	Enumerated values Array length: 0 to 100,000,000 characters

**Table 4** TicketInfoEnumData
Parameter	Type	Description
filed_key	String	Field Key. Minimum length: 0 character Maximum length: 255 characters
enum_key	String	Enumeration Key Minimum length: 0 character Maximum length: 255 characters
name_zh	String	Chinese name Minimum length: 0 character Maximum length: 255 characters
name_en	String	English name Minimum length: 0 character Maximum length: 255 characters

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID. Default value: 049 Minimum length: 3 characters Maximum length: 100,000,000 characters
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Default value: GOM.00000000 Minimum length: 1 character Maximum length: 100,000,000 characters
error_msg	String	Request response description. Minimum length: 0 character Maximum length: 100,000,000 characters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID. Default value: 049 Minimum length: 3 characters Maximum length: 100,000,000 characters
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Default value: GOM.00000000 Minimum length: 1 character Maximum length: 100,000,000 characters
error_msg	String	Request response description. Minimum length: 0 character Maximum length: 100,000,000 characters
data	CreateExternalIncidentResponseData object	data

**Table 7** CreateExternalIncidentResponseData
Parameter	Type	Description
incident_num	String	Incident ticket ID Minimum length: 0 character Maximum length: 255 characters

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
provider_code	String	Service ID. Default value: 049 Minimum length: 3 characters Maximum length: 100,000,000 characters
error_code	String	Request response code. The value ranges from 0000 to 9999. The value is 0 in normal cases. Default value: GOM.00000000 Minimum length: 1 character Maximum length: 100,000,000 characters
error_msg	String	Request response description. Minimum length: 0 character Maximum length: 100,000,000 characters

Request Example

GET https://IP:PORT/v1/external/incident/IM2024******08
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB

Response Example

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null,
    "data": {
        "incident_num": "IM202403181322030178042608",
        "region": [
            ""
        ],
        "enterprise_project": [
            "0"
        ],
        "current_cloud_service": [
            "6470681a31da2a47ed50a919"
        ],
        "incident_level": "level_50",
        "is_service_interrupt": true,
        "incident_type": "inc_type_p_function_issues",
        "incident_title": "tet",
        "incident_description": "25819b46251b46218bf6ad238ddd860c",
        "incident_source": "incident_source_manual",
        "incident_assignee": [
            "25819b46251b46218bf6ad238ddd860c"
        ],
        "assignee_scene": "",
        "assignee_role": "",
        "warroom_id": "WR202403181334366050100030",
        "handle_time": null,
        "status": "INCIDENT_STATUS_ACKNOWLEDGED",
        "create_time": 1710739323172,
        "creator": "1",
        "enum_data_list": [
            {
                "filed_key": "current_cloud_service_id",
                "enum_key": "6470681a31da2a47ed50a919",
                "name_zh": "COC",
                "name_en": "COC"
            },
            {
                "filed_key": "creator",
                "enum_key": "25819b46251b46218bf6ad238ddd860c",
                "name_zh": "coc-cim-user",
                "name_en": "coc-cim-user"
            },
            {
                "filed_key": "level_id",
                "enum_key": "level_50",
                "name_zh": "P5",
                "name_en": "P5"
            },
            {
                "filed_key": "work_flow_status",
                "enum_key": "INCIDENT_STATUS_ACKNOWLEDGED",
                "name_zh": "xxx",
                "name_en": "ACKNOWLEDGED"
            },
            {
                "filed_key": "mtm_type",
                "enum_key": "inc_type_p_function_issues",
                "name_zh": "xxx",
                "name_en": "function issues"
            },
            {
                "filed_key": "source_id",
                "enum_key": "incident_source_manual",
                "name_zh": "xxx",
                "name_en": "Manual Creation"
            },
            {
                "filed_key": "assignee",
                "enum_key": "25819b46251b46218bf6ad238ddd860c",
                "name_zh": "coc-cim-user",
                "name_en": "coc-cim-user"
            }
        ]
    }
}

Status Code

Status Code	Description
200	response
400	Error response

Error Code

None

Parent topic: Incident Management

Previous topic: Verifying the Incident Handling Result

Next topic: Incident-related Enumeration Information

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.

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