Skip to content

Latest commit

 

History

History
92 lines (75 loc) · 2.11 KB

operate_ticket.md

File metadata and controls

92 lines (75 loc) · 2.11 KB

Functional description

operate ticket

Request Parameters

{{ common_args_desc }}

Interface Parameters

Field Type Required Description
sn string YES ticket number
operator string YES ticket operator
action_type string YES operation type:SUSPEND(suspend)/UNSUSPEND(unsuspend)/WITHDRAW(withdraw)/TERMINATE(terminate)
action_message string NO ticket operate message(suspend and terminate)

demo1:suspend

{  
    "bk_app_secret": "xxxx", 
    "bk_app_code": "xxxx", 
    "bk_token": "xxxx", 
    "sn": "NO2019100818365320",
    "operator": "zhangsan",
    "action_type": "SUSPEND",
    "action_message": "test"
}

demo2:unsuspend

{
    "bk_app_secret": "xxxx", 
    "bk_app_code": "xxxx", 
    "bk_token": "xxxx", 
    "sn": "NO2019100818365320",
    "operator": "zhangsan",
    "action_type": "UNSUSPEND",
    "action_message": "test"
}

demo3:withdraw

{ 
    "bk_app_secret": "xxxx", 
    "bk_app_code": "xxxx", 
    "bk_token": "xxxx",
    "sn": "NO2019100818365320",
    "operator": "zhangsan",
    "action_type": "WITHDRAW",
    "action_message": "test"
}

demo4:terminate

{
    "bk_app_secret": "xxxx", 
    "bk_app_code": "xxxx", 
    "bk_token": "xxxx",
    "sn": "NO2019100818365320",
    "operator": "zhangsan",
    "action_type": "TERMINATE",
    "action_message": "test"
}

Return Result Example

{
    "message": "success",
    "code": 0,
    "data": [],
    "result": true
}

Return Result Description

Field Type Description
result bool true/false, indicate success or failure
code int return code. 0 indicates success, other values indicate failure
message string error message returned when result is false
data object data returned when result is true, details are described below