REST API for GoldenGate Veridata

Generate Column Mapping Pairs

post

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

Required Role: Administrator, SuperUser, CommandLineOperator

Create Column Mapping Pairs for viewing purpose. This will not save the column mappings in repository. This will only generate column mapping pairs to view the compare format and other information.

Request

Path Parameters

Id(required): integer(int64)

compare pair id

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

columnMapping: array columnMapping

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

Nested Schema : columnMapping

Type: array

Show Source

Array of: object ColumnMappingPair

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

Nested Schema : ColumnMappingPair

Type: object

Show Source

srcColumn: string
tgtColumn: string

{
    "type":"object",
    "properties":{
        "srcColumn":{
            "type":"string"
        },
        "tgtColumn":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Column Mapping Pairs created successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ColumnMapping

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

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"
    }
}

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."
        }
    }
}