REST API for GoldenGate Veridata

Generate Compare Pairs using mapped objects

post

http://{host}:{port}/veridata/v1/services/configuration/cps

Required Role: Administrator, SuperUser, CommandLineOperator

Create compare pairs for preview purpose.This will not save the compare pairs in repository.This API doesn't need group ID and hence should be used when compare pairs are to be previewed without mapped to any group.

Request

Query Parameters

includeColumnMapping: boolean

Include column mapping details in payload.
sourceConnectionId(required): integer(int64)

Source Connection ID.
targetConnectionId(required): integer(int64)

Target Connection ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

mappedObjectWithOptions: array mappedObjectWithOptions

{
    "type":"object",
    "properties":{
        "mappedObjectWithOptions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MappedObjectWithOptions"
            }
        }
    }
}

Nested Schema : mappedObjectWithOptions

Type: array

Show Source

Array of: object MappedObjectWithOptions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MappedObjectWithOptions"
    }
}

Nested Schema : MappedObjectWithOptions

Type: object

Show Source

options: object MappedObjectOptions
profileId: integer (int64)

Default Value: 1

Profile ID.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/MappedObjectRequest"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "options":{
            "$ref":"#/components/schemas/MappedObjectOptions"
        }
    }
}

Match All

Show Source

object MappedObjectRequest

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/MappedObjectRequest"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "options":{
            "$ref":"#/components/schemas/MappedObjectOptions"
        }
    }
}

Nested Schema : MappedObjectOptions

Type: object

Show Source

autoPartitionInfo: object AutoPartitionInfo
columnMapping: object ColumnMappingPattern
delta: object DeltaProcessing

Defines Delta Setting. For NSK this will be an empty object.
rowPartition: array rowPartition
srcEnscribeInfo: array srcEnscribeInfo
tgtEnscribeInfo: array tgtEnscribeInfo

{
    "type":"object",
    "properties":{
        "autoPartitionInfo":{
            "$ref":"#/components/schemas/AutoPartitionInfo"
        },
        "rowPartition":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CreateRowPartition"
            }
        },
        "delta":{
            "$ref":"#/components/schemas/DeltaProcessing"
        },
        "columnMapping":{
            "$ref":"#/components/schemas/ColumnMappingPattern"
        },
        "srcEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        },
        "tgtEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    }
}

Nested Schema : MappedObjectRequest

Type: object

Show Source

name: string

Mapping name . Default is source table name = target table name.
srcTable(required): srcTable

Represents a table in compare pair with table and row partitions info, if any.
tgtTable(required): tgtTable

Represents a table in compare pair with table and row partitions info, if any.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Mapping name . Default is source table name = target table name."
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReqTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReqTable"
                },
                {
                    "type":"object"
                }
            ]
        }
    },
    "required":[
        "srcTable",
        "tgtTable"
    ]
}

Nested Schema : AutoPartitionInfo

Type: object

Show Source

autoPartition: string

Allowed Values: [ false, true ]

Represents boolean TRUE/FALSE
autoPartitionNumber: integer (int32)

Default Value: 10

{
    "type":"object",
    "properties":{
        "autoPartition":{
            "$ref":"#/components/schemas/BooleanEnum"
        },
        "autoPartitionNumber":{
            "type":"integer",
            "format":"int32",
            "default":"10"
        }
    }
}

Nested Schema : ColumnMappingPattern

Type: object

Show Source

useAllColsAsKeys: boolean

Default Value: true
useSourceColsAsKeys: boolean

Default Value: true
useTargetColsAsKeys: boolean

Default Value: true

{
    "type":"object",
    "properties":{
        "useSourceColsAsKeys":{
            "type":"boolean",
            "default":true
        },
        "useTargetColsAsKeys":{
            "type":"boolean",
            "default":true
        },
        "useAllColsAsKeys":{
            "type":"boolean",
            "default":true
        }
    }
}

Nested Schema : DeltaProcessing

Type: object

Defines Delta Setting. For NSK this will be an empty object.

Show Source

srcColumn: string

Delta Source column.
srcDeltaCols: array srcDeltaCols

List of Source Delta columns.
srcDeltaQuery: string

Source Delta query.
tgtColumn: string

Delta Target column.
tgtDeltaCols: array tgtDeltaCols

List of Target Delta columns.
tgtDeltaQuery: string

Target Delta query.

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "type":"string",
            "description":"Delta Source column."
        },
        "tgtColumn":{
            "type":"string",
            "description":"Delta Target column."
        },
        "srcDeltaQuery":{
            "type":"string",
            "description":"Source Delta query."
        },
        "tgtDeltaQuery":{
            "type":"string",
            "description":"Target Delta query."
        },
        "srcDeltaCols":{
            "type":"array",
            "description":"List of Source Delta columns.",
            "items":{
                "type":"string"
            }
        },
        "tgtDeltaCols":{
            "type":"array",
            "description":"List of Target Delta columns.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Defines Delta Setting. For NSK this will be an empty object."
}

Nested Schema : rowPartition

Type: array

Show Source

Array of: CreateRowPartition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CreateRowPartition"
    }
}

Nested Schema : srcEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttributeRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnscribeAttributeRequest"
    }
}

Nested Schema : tgtEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttributeRequest

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EnscribeAttributeRequest"
    }
}

Nested Schema : srcDeltaCols

Type: array

List of Source Delta columns.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Source Delta columns.",
    "items":{
        "type":"string"
    }
}

Nested Schema : tgtDeltaCols

Type: array

List of Target Delta columns.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Target Delta columns.",
    "items":{
        "type":"string"
    }
}

Nested Schema : CreateRowPartition

Match All

Show Source

object RowPartitionSide
object RowPartitionParams

{
    "allOf":[
        {
            "$ref":"#/components/schemas/RowPartitionSide"
        },
        {
            "$ref":"#/components/schemas/RowPartitionParams"
        }
    ]
}

Nested Schema : RowPartitionSide

Type: object

Show Source

side: string

Allowed Values: [ "SOURCE", "TARGET" ]

SOURCE or TARGET.

{
    "type":"object",
    "properties":{
        "side":{
            "type":"string",
            "description":"SOURCE or TARGET.",
            "enum":[
                "SOURCE",
                "TARGET"
            ]
        }
    }
}

Nested Schema : RowPartitionParams

Type: object

Show Source

endingKey: string

Enscribe ending key.
isAscii: boolean

Enscribe is ASCII.
name(required): string
runtime: boolean

Use at runtime.
startingKey: string

Enscribe starting key.
type(required): string

Allowed Values: [ "S", "E", "A" ]

Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})
whereClause: string

SQL Predicate Statement.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "whereClause":{
            "type":"string",
            "description":"SQL Predicate Statement."
        },
        "endingKey":{
            "type":"string",
            "description":"Enscribe ending key."
        },
        "startingKey":{
            "type":"string",
            "description":"Enscribe starting key."
        },
        "type":{
            "type":"string",
            "description":"Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})",
            "enum":[
                "S",
                "E",
                "A"
            ]
        },
        "isAscii":{
            "type":"boolean",
            "description":"Enscribe is ASCII."
        },
        "runtime":{
            "type":"boolean",
            "description":"Use at runtime."
        }
    },
    "required":[
        "type",
        "name"
    ]
}

Nested Schema : EnscribeAttributeRequest

Type: object

Show Source

default: boolean
name: string

Allowed Values: [ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
value: string

{
    "type":"object",
    "properties":{
        "name":{
            "$ref":"#/components/schemas/EnscribeAttributeEnum"
        },
        "default":{
            "type":"boolean"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : srcTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object ReqTable

Defines a table in request body.
object srcTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/ReqTable"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : tgtTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object ReqTable

Defines a table in request body.
object tgtTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/ReqTable"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ReqTable

Type: object

Defines a table in request body.

Show Source

catalog: string
filePattern: string

Valid for NSK Enscribe database.
name: string
schema: string
tablePartition: object tablePartition

{
    "type":"object",
    "description":"Defines a table in request body.",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        },
        "filePattern":{
            "type":"string",
            "description":"Valid for NSK Enscribe database."
        },
        "tablePartition":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TablePartition"
                }
            ]
        }
    }
}

Nested Schema : srcTable-allOf[1]

Type: object

Nested Schema : tablePartition

Type: object

Match All

Show Source

object TablePartition

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TablePartition"
        }
    ]
}

Nested Schema : TablePartition

Type: object

Show Source

name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : tgtTable-allOf[1]

Type: object

Response

Supported Media Types

application/json

200 Response

Compare Pairs created successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ComparePairInDetailsView

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ComparePairInDetailsView"
    }
}

Nested Schema : ComparePairInDetailsView

Type: object

Show Source

columnMappings: array columnMappings
columnsSystemMapped: boolean

Default Value: true

Is the key columns system mapped.
delta: delta
deltaProcessingEnabled: boolean

Default Value: false

Delta processing is enabled for this compare pair.
enabled: boolean

Default Value: true

Compare Pair is enabled in the group to run.
keyColumnsSystemMapped: boolean

Default Value: true

Is the key columns system mapped.
profile: profile

Profile Object.
setting: object ComparePairSetting

Mapping of a column in a table.
srcIndexName: string
srcRowPartitions: array srcRowPartitions
srcTable: srcTable

Represents a table in compare pair with table and row partitions info, if any.
tgtIndexName: string
tgtRowPartitions: array tgtRowPartitions
tgtTable: tgtTable

Represents a table in compare pair with table and row partitions info, if any.
validationStatus: string

Allowed Values: [ "NeverValidated", "Validated" ]

enum for compare pair validation status.
validationTime: string (date-time)

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_2"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profile":{
            "description":"Profile Object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BaseObject_3"
                },
                {
                    "type":"object"
                }
            ]
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "columnMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ColumnMapping"
            }
        },
        "setting":{
            "$ref":"#/components/schemas/ComparePairSetting"
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "delta":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeltaProcessing"
                }
            ]
        },
        "keyColumnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "columnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "srcIndexName":{
            "type":"string"
        },
        "tgtIndexName":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run.",
            "default":true
        },
        "deltaProcessingEnabled":{
            "type":"boolean",
            "description":"Delta processing is enabled for this compare pair.",
            "default":false
        },
        "validationTime":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "$ref":"#/components/schemas/ComparePairValidationStatus"
        }
    }
}

Match All

Show Source

object BaseObject_2
object ComparePairInDetailsView-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_2"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profile":{
            "description":"Profile Object.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BaseObject_3"
                },
                {
                    "type":"object"
                }
            ]
        },
        "srcTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "tgtTable":{
            "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
            "allOf":[
                {
                    "$ref":"#/components/schemas/BasicTable"
                },
                {
                    "type":"object"
                }
            ]
        },
        "columnMappings":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ColumnMapping"
            }
        },
        "setting":{
            "$ref":"#/components/schemas/ComparePairSetting"
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartition"
            }
        },
        "delta":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/DeltaProcessing"
                }
            ]
        },
        "keyColumnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "columnsSystemMapped":{
            "type":"boolean",
            "description":"Is the key columns system mapped.",
            "default":true
        },
        "srcIndexName":{
            "type":"string"
        },
        "tgtIndexName":{
            "type":"string"
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run.",
            "default":true
        },
        "deltaProcessingEnabled":{
            "type":"boolean",
            "description":"Delta processing is enabled for this compare pair.",
            "default":false
        },
        "validationTime":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "$ref":"#/components/schemas/ComparePairValidationStatus"
        }
    }
}

Nested Schema : columnMappings

Type: array

Show Source

Array of: object ColumnMapping

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ColumnMapping"
    }
}

Nested Schema : delta

Match All

Show Source

object DeltaProcessing

Defines Delta Setting. For NSK this will be an empty object.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DeltaProcessing"
        }
    ]
}

Nested Schema : profile

Profile Object.

Match All

Profile Object.

Show Source

object BaseObject_3
object profile-allOf[1]

{
    "description":"Profile Object.",
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_3"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : ComparePairSetting

Type: object

Mapping of a column in a table.

Show Source

compareMethod: string

Allowed Values: [ "Key", "Hash", "Literal" ]

Compare Mapping Type.
exclude: array exclude

Array of column names which are excluded.
keyColsMappingMethod: string

Allowed Values: [ "system", "user" ]

Column Mapping Method.
otherColsMappingMethod: string

Allowed Values: [ "system", "user" ]

Column Mapping Method.
srcIndexType: string

Allowed Values: [ "index", "columns" ]

Source/Target Key Index.
tgtIndexType: string

Allowed Values: [ "index", "columns" ]

Source/Target Key Index.
unmapped: array unmapped

Array of column names which are unmapped.

{
    "type":"object",
    "properties":{
        "compareMethod":{
            "$ref":"#/components/schemas/CompareMappingType"
        },
        "keyColsMappingMethod":{
            "$ref":"#/components/schemas/ColumnMappingMethod"
        },
        "otherColsMappingMethod":{
            "$ref":"#/components/schemas/ColumnMappingMethod"
        },
        "srcIndexType":{
            "$ref":"#/components/schemas/KeyIndexType"
        },
        "tgtIndexType":{
            "$ref":"#/components/schemas/KeyIndexType"
        },
        "unmapped":{
            "type":"array",
            "description":"Array of column names which are unmapped.",
            "items":{
                "type":"string"
            }
        },
        "exclude":{
            "type":"array",
            "description":"Array of column names which are excluded.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Mapping of a column in a table."
}

Nested Schema : srcRowPartitions

Type: array

Show Source

Array of: RowPartition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RowPartition"
    }
}

Nested Schema : srcTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object BasicTable

Defines a table.
object srcTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/BasicTable"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : tgtRowPartitions

Type: array

Show Source

Array of: RowPartition

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RowPartition"
    }
}

Nested Schema : tgtTable

Represents a table in compare pair with table and row partitions info, if any.

Match All

Represents a table in compare pair with table and row partitions info, if any.

Show Source

object BasicTable

Defines a table.
object tgtTable-allOf[1]

{
    "description":"Represents a table in compare pair with table and row partitions info, if any.\n",
    "allOf":[
        {
            "$ref":"#/components/schemas/BasicTable"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : BaseObject_2

Type: object

Show Source

createdOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z
id: integer (int64)

Object Id.
name: string

Object Name.
updatedOn: string (date-time)

Pattern: YYYY-MM-DDTHH:mm:ss.sssZ

Example: 2024-02-03T10:15:30Z

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "updatedOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        }
    }
}

Nested Schema : ComparePairInDetailsView-allOf[1]

Type: object

Nested Schema : ColumnMapping

Type: object

Show Source

compareFormat: string

Allowed Values: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

Compare Format.
dataType: string
mappingType: string

Allowed Values: [ "Key", "Hash", "Literal" ]

Compare Mapping Type.
precision: integer (int32)

Default Value: 0
scale: integer (int32)

Default Value: 0
srcColumn: object Column

Defines a column.
supportedCompareFormats: array supportedCompareFormats
tgtColumn: object Column

Defines a column.
timezone: string

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "$ref":"#/components/schemas/Column"
        },
        "tgtColumn":{
            "$ref":"#/components/schemas/Column"
        },
        "compareFormat":{
            "$ref":"#/components/schemas/CompareFormat"
        },
        "mappingType":{
            "$ref":"#/components/schemas/CompareMappingType"
        },
        "dataType":{
            "type":"string"
        },
        "precision":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "scale":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "timezone":{
            "type":"string"
        },
        "supportedCompareFormats":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CompareFormat"
            }
        }
    }
}

Nested Schema : Column

Type: object

Defines a column.

Show Source

columnName: string

Column Name.
dataType: string

Data type of the column.
jdbcType: integer (int32)

java.sql.Types type number.
lob: boolean
precision: integer (int32)

Default Value: 0
scale: integer (int32)

Default Value: 0
timezone: string
typeNum: integer (int32)

internal column type number.

{
    "type":"object",
    "description":"Defines a column.",
    "properties":{
        "columnName":{
            "type":"string",
            "description":"Column Name."
        },
        "dataType":{
            "type":"string",
            "description":"Data type of the column."
        },
        "precision":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "scale":{
            "type":"integer",
            "format":"int32",
            "default":"0"
        },
        "timezone":{
            "type":"string"
        },
        "jdbcType":{
            "type":"integer",
            "format":"int32",
            "description":"java.sql.Types type number."
        },
        "typeNum":{
            "type":"integer",
            "format":"int32",
            "description":"internal column type number."
        },
        "lob":{
            "type":"boolean"
        }
    }
}

Nested Schema : supportedCompareFormats

Type: array

Show Source

Array of: string

Allowed Values: [ "string", "string_en", "binary", "timestamp", "timestamp_tz", "date", "time", "datetime", "smalldatetime", "clob", "blob", "Float", "dec_float", "interval", "number", "binary_timestamp", "string_nfc", "clob_nfc", "sybtime", "bit", "Double" ]

Compare Format.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CompareFormat"
    }
}

Nested Schema : DeltaProcessing

Type: object

Defines Delta Setting. For NSK this will be an empty object.

Show Source

srcColumn: string

Delta Source column.
srcDeltaCols: array srcDeltaCols

List of Source Delta columns.
srcDeltaQuery: string

Source Delta query.
tgtColumn: string

Delta Target column.
tgtDeltaCols: array tgtDeltaCols

List of Target Delta columns.
tgtDeltaQuery: string

Target Delta query.

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "type":"string",
            "description":"Delta Source column."
        },
        "tgtColumn":{
            "type":"string",
            "description":"Delta Target column."
        },
        "srcDeltaQuery":{
            "type":"string",
            "description":"Source Delta query."
        },
        "tgtDeltaQuery":{
            "type":"string",
            "description":"Target Delta query."
        },
        "srcDeltaCols":{
            "type":"array",
            "description":"List of Source Delta columns.",
            "items":{
                "type":"string"
            }
        },
        "tgtDeltaCols":{
            "type":"array",
            "description":"List of Target Delta columns.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Defines Delta Setting. For NSK this will be an empty object."
}

Nested Schema : srcDeltaCols

Type: array

List of Source Delta columns.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Source Delta columns.",
    "items":{
        "type":"string"
    }
}

Nested Schema : tgtDeltaCols

Type: array

List of Target Delta columns.

Show Source

Array of: string

{
    "type":"array",
    "description":"List of Target Delta columns.",
    "items":{
        "type":"string"
    }
}

Nested Schema : BaseObject_3

Type: object

Show Source

id: integer (int64)

Object Id.
name: string

Object Name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        }
    }
}

Nested Schema : profile-allOf[1]

Type: object

Nested Schema : exclude

Type: array

Array of column names which are excluded.

Show Source

Array of: string

{
    "type":"array",
    "description":"Array of column names which are excluded.",
    "items":{
        "type":"string"
    }
}

Nested Schema : unmapped

Type: array

Array of column names which are unmapped.

Show Source

Array of: string

{
    "type":"array",
    "description":"Array of column names which are unmapped.",
    "items":{
        "type":"string"
    }
}

Nested Schema : RowPartition

Match All

Show Source

object BaseRowPartition
object RowPartitionParams

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseRowPartition"
        },
        {
            "$ref":"#/components/schemas/RowPartitionParams"
        }
    ]
}

Nested Schema : BaseRowPartition

Type: object

Show Source

id: integer (int64)

Row Partition ID

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Row Partition ID",
            "format":"int64"
        }
    }
}

Nested Schema : RowPartitionParams

Type: object

Show Source

endingKey: string

Enscribe ending key.
isAscii: boolean

Enscribe is ASCII.
name(required): string
runtime: boolean

Use at runtime.
startingKey: string

Enscribe starting key.
type(required): string

Allowed Values: [ "S", "E", "A" ]

Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})
whereClause: string

SQL Predicate Statement.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "whereClause":{
            "type":"string",
            "description":"SQL Predicate Statement."
        },
        "endingKey":{
            "type":"string",
            "description":"Enscribe ending key."
        },
        "startingKey":{
            "type":"string",
            "description":"Enscribe starting key."
        },
        "type":{
            "type":"string",
            "description":"Type of Row Partition (SQL{S} , Enscribe{E} , Auto{A})",
            "enum":[
                "S",
                "E",
                "A"
            ]
        },
        "isAscii":{
            "type":"boolean",
            "description":"Enscribe is ASCII."
        },
        "runtime":{
            "type":"boolean",
            "description":"Use at runtime."
        }
    },
    "required":[
        "type",
        "name"
    ]
}

Nested Schema : BasicTable

Type: object

Defines a table.

Show Source

catalog: string
isView: boolean
name: string
schema: string
tablePartition: object tablePartition

{
    "type":"object",
    "description":"Defines a table.",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        },
        "isView":{
            "type":"boolean"
        },
        "tablePartition":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/TablePartition"
                }
            ]
        }
    }
}

Nested Schema : srcTable-allOf[1]

Type: object

Nested Schema : tablePartition

Type: object

Match All

Show Source

object TablePartition

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TablePartition"
        }
    ]
}

Nested Schema : TablePartition

Type: object

Show Source

name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : tgtTable-allOf[1]

Type: object

400 Response

Bad Request.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 Response

Unauthorized.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 Response

Not Found.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 Response

Server Error.

Root Schema : Error

Type: object

Show Source

errCode: string

Veridata Error Code.
errMsg: string

Veridata Error Message.

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}