Updated on 2024-06-20 GMT+08:00

Accepting an Incident Ticket

Function

This API is used to accept an incident ticket.

URI

POST /v1/external/incident/handle

Remarks: The URIs of operations such as handling, submitting solutions, and verifying solutions are the same.

Request Parameters

Table 1 Request body parameter

Parameter

Mandatory

Type

Description

incident_num

Yes

String

Incident ticket number, for example, IM202403181322030178042608.

Minimum length: 0 character

Maximum length: 255 characters

operator

Yes

String

Operator ID, for example, 00909e0a9c0a49a1b5e1c3eac362e3d7. You can query the operator ID on the Basic Configuration > Personnel Management page.

Minimum length: 0 character

Maximum length: 255 characters

operate_key

Yes

String

Operation type. The value is fixed to acceptedIncident1.

Minimum length: 0 character

Maximum length: 255 characters

Fixed value:

parameter

No

Map<String,Object>

Input parameter. Currently, there is no parameter for handling. Leave this parameter empty or leave it empty.

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

Status code: 400

Table 3 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

POST https://IP:PORT/v1/external/incident/handle
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB
Request body:
{
    "incident_num":"IM202403221515060171753781",
    "operator":"7da46971b7e24eed90cf777cc2ff8b91",
    "operate_key":"acceptedIncident1",
    "parameter":{}
}

Response Example

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

Status Code

Status Code

Description

200

response

400

Error response

Error Description

Status Code

Description

The field[operate_key] value[acceptedIncident111] invalid

Invalid operate_key.

incidentNum size must be between 0 and 255

The value of incident_num is too long.