Delete Schema Comparison Task
Use this API to delete a specified schema comparison task. Delete only tasks that are no longer needed for comparison, audit, or troubleshooting workflows.
Request URL: /openapi/v1/compareschema/delete
Request Method: POST
Before You Call
taskId can be obtained from data.taskId in the successful response of Create Schema Comparison Task, or from data.schemaComparisons[].taskId returned by List Schema Comparison Tasks.
Request Body
{
"taskId": "cc-th6j3fs58y"
}
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| taskId | String | Yes | Schema comparison task ID to delete. | cc-th6j3fs58y |
Response Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Whether the request is successful. | true |
| requestId | String | Request ID, which can be used for troubleshooting and tracing. | Jj0v4QET-FLMGdDEnHLLd5SRdGMt9ZEN |
| message | String | Error message returned when the request fails. | task not found |
Successful Invocation Example
{
"success": true,
"requestId": "Jj0v4QET-FLMGdDEnHLLd5SRdGMt9ZEN"
}
Result
A successful response confirms that the delete request was accepted. Query the task list afterward if your automation needs to confirm that the task is no longer available.