Skip to main content

Start Schema Comparison Precheck

Start the precheck for a specified schema comparison task.

Request URL: /openapi/v1/compareschema/precheck/start

Request Method: POST

Before You Call

taskId can be obtained from data.taskId in the successful response of Create Schema Comparison Task.

Request Body

{
"taskId": "cc-th6j3fs58y"
}

Request Parameters

ParameterTypeRequiredDescriptionExample
taskIdStringYesSchema comparison task ID for which to start the precheck.cc-th6j3fs58y

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID, which can be used for troubleshooting and tracing.Dm7u8WSZ-jpqkhAMnlpps5BKdkon8JAV
dataObjectPrecheck start result. See the fields below.See the example below
messageStringError message returned when the request fails.task not found

data Fields

ParameterTypeDescriptionExample
taskIdStringSchema comparison task ID.cc-th6j3fs58y
precheckTaskIdStringPrecheck task ID submitted this time.pcte-dji009w2k499

Successful Invocation Example

{
"success": true,
"requestId": "Dm7u8WSZ-jpqkhAMnlpps5BKdkon8JAV",
"data": {
"taskId": "cc-th6j3fs58y",
"precheckTaskId": "pcte-dji009w2k499"
}
}