Changing the Status of a Service Ticket

Function

This API is used to change the change ticket status. The value of ticket_type in the request path is fixed to change, and the change ticket number is transferred to ticket_id. This API is used to start, end, cancel, and add change results.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:ticket:update	Write	-	-	-	-

URI

PUT /v1/{ticket_type}/tickets/{ticket_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
ticket_type	Yes	String	Definition: Type of the service ticket to be modified. change indicates that the change ticket status is updated. Constraints: N/A Value range: change Default value: N/A
ticket_id	Yes	String	Definition: Change ticket number. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
ticket_info	No	ticket_info object	\| Description: Information about the change ticket. When operations are performed on a change sub-ticket, the information about the change ticket does not need to be transferred. When operations such as review and cancellation are performed on a change ticket, the information about the change ticket needs to be transferred. Constraints: N/A. Value range: N/A. Default value: N/A.
sub_tickets	No	Array of sub_tickets objects	\| Description: Information about the change sub-ticket. Each change region of a change ticket has a corresponding change sub-ticket. Operations such as starting a change, canceling a change, and filling back a change result can be performed on each change sub-ticket. Constraints: N/A. Value range: N/A. Default value: N/A.
history_info	No	history_info object	\| Description: Action of the update operation. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 3** ticket_info
Parameter	Mandatory	Type	Description
phase	No	String	\| Description: Ticket operation type. The value is of the enumerated type. Constraints: N/A Value Range: The enumerated values are as follows: - phase_change_end: completed - phase_change_cancel: canceled - phase_change_draft: draft - phase_change_implemente: change implementation and verification - phase_change_apply: applicant confirmation - phase_change_approve: approval - phase_change_close: closed Default Value: N/A
work_flow_status	No	String	\| Description: Ticket status. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 4** sub_tickets
Parameter	Mandatory	Type	Description
ticket_id	No	String	\| Description: Sub-ticket ID. Constraints: N/A. Value range: N/A. Default value: N/A.
change_result	No	String	\| Description: Change result. Constraints: N/A. Value range: N/A. Default value: N/A.
is_verified_in_change_time	No	Boolean	\| Description: Whether the verification can be performed in the time window. Constraints: N/A. Value range: N/A. Default value: N/A.
verified_docs	No	String	\| Description: Verification document ID. Constraints: N/A. Value range: N/A. Default value: N/A.
comment	No	String	\| Description: Description of the change failure cause. Constraints: N/A. Value range: N/A. Default value: N/A.
change_fail_type	No	String	\| Description: Change failure type. Constraints: N/A. Value range: N/A. Default value: N/A.
rollback_start_time	No	Long	\| Description: Start time of a rollback. Constraints: N/A. Value range: N/A. Default value: N/A.
rollback_end_time	No	Long	\| Description: Rollback end time. Constraints: N/A. Value range: N/A. Default value: N/A.
is_rollback_success	No	Boolean	\| Description: Whether the rollback is successful. Constraints: N/A. Value range: N/A. Default value: N/A.
is_monitor_found	No	Boolean	\| Description: Whether the issue is detected by monitoring. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 5** history_info
Parameter	Mandatory	Type	Description
action	No	String	\| Description: Operation type. Constraints: N/A Value range: - change_start_change_success: The change starts. - change_end_change_success: The change ends. - change_set_change_result_success: The change is successful. - change_result_failed: The change fails. - change_cancel_change_success: The change is canceled. Default value: N/A

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
provider_code	String	Definition: Service ID. Value range: N/A Default value: 049
error_code	String	Definition: Request response code. Value range: GOM.00000000~GOM.00009999999 Default value: GOM.00000000
error_msg	String	Definition: Response description for a request. Value range: N/A
data	data object	Definition: Data returned after the change order status is updated. Value range: N/A

**Table 7** data
Parameter	Type	Description
is_start_process_async	Boolean	Definition: Whether to start the process asynchronously. The value is fixed to true, indicating that the background ticket creation process is an asynchronous process. Value range: true Default value: true
is_update_null	Boolean	Definition: Whether to resubmit the empty field. Value range: false Default value: false
is_return_full_info	Boolean	Definition: Whether to return all fields. Value range: false Default value: false
is_start_process	Boolean	Definition: Whether to start the process. If this parameter is set to false, the created ticket is in the draft state. The preset value is true. The created ticket is in the unhandled state. Value range: false Default value: false
ticket_id	String	Definition: ID of the change order to be updated. Value range: N/A

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
provider_code	String	Definition: Service ID. Value range: N/A Default value: 049
error_code	String	Definition: Request response code. Value range: GOM.00000000~GOM.00009999999 Default value: GOM.00000000
error_msg	String	Definition: Response description for a request. Value range: N/A

Example Requests

Change started.

PUT https://{Endpoint}/v1/change/tickets/CM202506261919380164485133

{
  "history_info" : {
    "action" : "change_start_change_success"
  },
  "sub_tickets" : [ {
    "ticket_id" : "e72f9b49-2294-4c58-bc57-4a0c6903c5e1"
  } ]
}

Change ended.

PUT https://{Endpoint}/v1/change/tickets/CM202506261919380164485133

{
  "history_info" : {
    "action" : "change_end_change_success"
  },
  "sub_tickets" : [ {
    "ticket_id" : "e72f9b49-2294-4c58-bc57-4a0c6903c5e1"
  } ]
}

If the change is successful, fill in the change result.

PUT https://{Endpoint}/v1/change/tickets/CM202506261919380164485133

{
  "sub_tickets" : [ {
    "ticket_id" : "e72f9b49-2294-4c58-bc57-4a0c6903c5e1",
    "sub_tickets" : [ ],
    "change_result" : "change_result_success",
    "is_verified_in_change_time" : true,
    "verified_docs" : null,
    "comment" : "Change succeeded."
  } ],
  "history_info" : {
    "action" : "change_set_change_result_success"
  }
}

If the change fails, fill in the change result.

PUT https://{Endpoint}/v1/change/tickets/CM202506261919380164485133

{
  "sub_tickets" : [ {
    "ticket_id" : "80f198c6-14c0-4541-8e2d-1808bfcedf48",
    "sub_tickets" : [ ],
    "change_result" : "change_result_failed",
    "verified_docs" : null,
    "comment" : "Change failed.",
    "change_fail_type" : "fr_dependent_service_issue",
    "rollback_start_time" : null,
    "rollback_end_time" : null,
    "is_rollback_success" : true,
    "is_monitor_found" : false
  } ],
  "history_info" : {
    "action" : "change_set_change_result_success"
  }
}

Change canceled.

PUT https://{Endpoint}/v1/change/tickets/CM202506261919380164485133

{
  "history_info" : {
    "action" : "change_cancel_change_success"
  },
  "sub_tickets" : [ {
    "ticket_id" : "b0a966fa-5be7-40e4-bad0-a0749d6fac9c",
    "sub_tickets" : [ ],
    "change_result" : "change_result_cancel",
    "comment" : "Change cancelled."
  } ]
}

Example Responses

Status code: 200

Request succeeded.

For more status codes, see Status Codes.

{
  "error_code" : "GOM.00000000",
  "error_msg" : null,
  "provider_code" : 4,
  "data" : {
    "ticket_info" : {
      "is_start_process_async" : true,
      "is_update_null" : false,
      "is_return_full_info" : false,
      "is_start_process" : true,
      "ticket_id" : "CM202506261919380164485133",
      "sub_tickets" : [ ],
      "enum_data_list" : [ ]
    },
    "history_info" : null
  }
}