Skip to main content

Value Format

Interface Overview

Gets a value format template to display when creating a task

Interface Address

/cloudcanal/console/api/v1/openapi/constant/schemalessvalueformattemplate

Request Manner

POST

Request Parameters

ParameterNameParameter DescriptionRequestTypeWhether RequiredDataType
schemaLessValueFormatList of value formats, obtained and selected from Cache data source value formats or Message queue data source value formatsBodyTrueString

Public Response Results

ParameterNameParameter DescriptionType(Java)NotNull
code1: Success
0: Failure
StringTrue
dataObjectFalse
msgStringFalse
requestIdStringTrue

Data Parameters

The data value is a json string used primarily for presentation, where ${data} can be replaced with a real list of columns and values.

Response Example

{
"requestId": "b75bd041-2be7-11ec-b616-4fb795c60cd5",
"code": "1",
"msg": "request success",
"data": "{\n \"action\": \"INSERT/UPDATE/DELETE\",\n \"bid\": 1,\n \"before\": [],\n \"data\": ${data},\n \"db\": ${db},\n \"schema\": ${schema},\n \"table\":${table},\n \"dbValType\": ${dbValType},\n \"jdbcType\": ${jdbcType},\n \"entryType\": \"ROWDATA\",\n \"isDdl\": false,\n \"pks\": ${pks},\n \"execTs\": 0,/*sql execute in db timestamp*/\n \"sendTs\": 0,/*msg sent timestamp*/\n \"sql\": \"\"}"
}