Description

API for terminating business flow instances

Request Specification

Method: POST + application/json

Endpoint: https://${cloud domain}/cgi/crm/v2/special/instance/cancel?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
data	Map	Yes	Data map
instanceId	String	Yes	Instance ID
reason	String	No	Termination reason

Request Example

{
  "data": {
    "reason": "",
    "instanceId": "xxx"
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes Reference

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgments as errorMessage may change;