Creating an Incident Ticket

Updated on 2024-10-21 GMT+08:00

View PDF

Function

This API is used to create an incident service ticket.

URI

POST /v1/external/incident/create

Request Parameters

**Table 1** Request body parameter
Parameter	Mandatory	Type	Description
region	No	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	No	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	Yes	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	Yes	String	Incident level. For details about the incident level, see Incident Level. Minimum length: 0 character Maximum length: 255 characters
is_service_interrupt	Yes	Boolean	Whether the service is interrupted. The value can be true or false. The value can be: true false
incident_type	Yes	String	Incident type. For details about the event type, see Incident Type. Minimum length: 0 character Maximum length: 255 characters
incident_title	Yes	String	Incident title. The value contains a maximum of 200 characters. Minimum length: 0 character Maximum length: 200 characters
incident_description	Yes	String	Incident description. The value can contain a maximum of 600 characters. Minimum length: 0 character Maximum length: 600 characters
incident_source	Yes	String	Incident source. For details about the incident source, see Incident Source. Minimum length: 0 character Maximum length: 255 characters
incident_assignee	No	Array of strings	The owner. Either of the scheduling scenario or scheduling role must be set (scheduling scenario and scheduling role are combined fields). Minimum length: 0 character Maximum length: 255 characters Array length: 0 to 1 characters
assignee_scene	No	String	The scheduling scenario. Either of the scheduling scenario or scheduling role must be set (scheduling scenario and scheduling role are combined fields). Minimum length: 0 characters Maximum length: 255 characters
assignee_role	No	String	Scheduling role, whose value varies according to that of the scheduling scenario. Minimum length: 0 character Maximum length: 255 characters
creator	Yes	String	Ticket creator Minimum length: 0 character Maximum length: 255 characters

CAUTION:

One of incident_assignee (owner), assignee_scene (scheduling scenario), assignee_role (shift role) must be set. If incident_assignee is set, assignee_scene and assignee_role can be left empty. The assignee_scene and assignee_role are bound together.

If no personnel are added to assignee_role, the large tenant is added to incident_assignee as the incident owner by default.

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: 100000000
error_msg	String	Request response description. Minimum length: 0 character Maximum length: 100,000,000 characters
data	CreateExternalIncidentResponseData object	data

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

Status code: 400

**Table 4** 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/create
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB
Request Body:
{
    "region": [
        "cn-southwest-252"
    ],
    "enterprise_project": [
        "ab080d9f-6b97-4e73-8679-b6d76057f274"
    ],
    "current_cloud_service": [
        "65659ae2f42bf80e5f3f0635"
    ],
    "incident_level": "level_50",
    "is_service_interrupt": "true",
    "incident_type": "inc_type_p_security_issues",
    "incident_title": "Test Time Ticket No. 10001",
    "incident_description": "Test time Ticket No. 10001",
    "incident_source": "incident_source_manual",
    "incident_assignee": ["7da46971b7e24eed90cf777cc2ff8b91"],
    "creator": "7da46971b7e24eed90cf777cc2ff8b91",
    "assignee_scene": "",
    "assignee_role": ""
}

Response Example

{
    "provider_code": "049",
    "error_code": "GOM.00000000",
    "error_msg": null,
    "data": {
        "incident_num": "IM202403221515060171753781"
    }
}

Parent topic: Incident Management

Previous topic: Incident Management

Next topic: Accepting an Incident Ticket