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

Verifying the Incident Handling Result

Function

This API is used to verify the 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 ID

Minimum length: 0 character

Maximum length: 255 characters

operator

Yes

String

Operator ID

Minimum length: 0 character

Maximum length: 255 characters

operate_key

Yes

String

Operation type. The value is confirm.

Minimum length: 0 character

Maximum length: 255 characters

Fixed value

parameter

Yes

Map<String,Object>

Input parameters

parameter.virtual_confirm_result

Yes

Boolean

Verification result. The value can be true (default) or false.

parameter.virtual_confirm_comment

Yes

String

Verification description. The value contains a maximum of 300 characters.

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 request success

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

GET https://IP:PORT/v1/external/incident/handle
Request Headers:
Content-Type: application/json
X-Auth-Token: MI*******ghkgB
{
    "incident_num":"IM202403221515060171753781",
    "operator":"7da46971b7e24eed90cf777cc2ff8b91",
    "operate_key":"confirm",
    "parameter":{
        "virtual_confirm_result": false,
        "virtual_confirm_comment": "13"
    }
}

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 code

None