1. REST API for GoldenGate Veridata
  2. Tasks
  3. Configure
  4. Compare Pairs

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
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Example:
{
    "mappedObjectWithOptions":[
        {
            "name":"EMPLOYEE=EMPLOYEE",
            "srcTable":{
                "name":"EMPLOYEE",
                "schema":"VERIDATA",
                "catalog":"ORCL1",
                "tablePartition":{
                    "name":"EMP_2025"
                }
            },
            "tgtTable":{
                "name":"EMPLOYEE",
                "schema":"VERIDATA",
                "catalog":"ORCL1",
                "tablePartition":{
                    "name":"EMP_2025"
                }
            },
            "profileId":1,
            "options":{
                "autoPartitionInfo":{
                    "autoPartition":true,
                    "autoPartitionNumber":10
                }
            },
            "rowPartition":[
                {
                    "side":"SOURCE",
                    "name":"employee ID's greater than 100",
                    "whereClause":"ID > 100",
                    "type":"S",
                    "runtime":true
                },
                {
                    "side":"TARGET",
                    "name":"employee ID's greater than 100",
                    "whereClause":"ID > 100",
                    "type":"S",
                    "runtime":true
                }
            ],
            "delta":{
                "srcColumn":"UPDATED_DATE",
                "tgtColumn":"UPDATED_DATE",
                "srcDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                "tgtDeltaQuery":"select MAX(UPDATED_DATE) from ORCL1.VERIDATA.EMPLOYEE",
                "srcDeltaCols":[
                    "UPDATED_DATE, MODIFIED_TS"
                ],
                "tgtDeltaCols":[
                    "UPDATED_DATE, MODIFIED_TS"
                ],
                "columnMapping":[
                    {
                        "useSourceColsAsKeys":true,
                        "useTargetColsAsKeys":true,
                        "useAllColsAsKeys":true
                    }
                ]
            }
        }
    ]
}
Nested Schema : mappedObjectWithOptions
Type: object
Match All
Show Source
Nested Schema : MappedObjectWithOptions
Type: object
Show Source
Match All
Show Source
Nested Schema : MappedObjectRequest
Type: object
Show Source
Nested Schema : DeltaProcessing
Type: object
Defines Delta Setting. For NSK this will be an empty object.
Show Source
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.
Represents a table in compare pair with table and row partitions info, if any.
Show Source
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.
Represents a table in compare pair with table and row partitions info, if any.
Show Source
Nested Schema : srcDeltaCols
Type: array
List of Source Delta columns.
Show Source
Nested Schema : tgtDeltaCols
Type: array
List of Target Delta columns.
Show Source
Nested Schema : ReqTable
Type: object
Defines a table in request body.
Show Source
Nested Schema : srcTable-allOf[1]
Type: object
Nested Schema : tablePartition
Type: object
Match All
Show Source
Nested Schema : TablePartition
Type: object
Show Source
Nested Schema : tgtTable-allOf[1]
Type: object
Back to Top

Response

Supported Media Types

200 Response

Compare Pairs created successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ComparePairInDetailsView
Type: object
Show Source
Match All
Show Source
Nested Schema : columnMappings
Type: array
Show Source
Nested Schema : delta
Match All
Show Source
Nested Schema : profile
Profile Object.
Match All
Profile Object.
Profile Object.
Show Source
Nested Schema : ComparePairSetting
Type: object
Mapping of a column in a table.
Show Source
Nested Schema : srcRowPartitions
Type: array
Show Source
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.
Represents a table in compare pair with table and row partitions info, if any.
Show Source
Nested Schema : tgtRowPartitions
Type: array
Show Source
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.
Represents a table in compare pair with table and row partitions info, if any.
Show Source
Nested Schema : BaseObject_2
Type: object
Show Source
Nested Schema : ComparePairInDetailsView-allOf[1]
Type: object
Nested Schema : ColumnMapping
Type: object
Show Source
Nested Schema : Column
Type: object
Defines a column.
Show Source
Nested Schema : supportedCompareFormats
Type: array
Show Source
  • 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.
Nested Schema : DeltaProcessing
Type: object
Defines Delta Setting. For NSK this will be an empty object.
Show Source
Nested Schema : srcDeltaCols
Type: array
List of Source Delta columns.
Show Source
Nested Schema : tgtDeltaCols
Type: array
List of Target Delta columns.
Show Source
Nested Schema : BaseObject_3
Type: object
Show Source
Nested Schema : profile-allOf[1]
Type: object
Nested Schema : exclude
Type: array
Array of column names which are excluded.
Show Source
Nested Schema : unmapped
Type: array
Array of column names which are unmapped.
Show Source
Nested Schema : RowPartition
Match All
Show Source
Nested Schema : BaseRowPartition
Type: object
Show Source
Nested Schema : RowPartitionParams
Type: object
Show Source
Nested Schema : BasicTable
Type: object
Defines a table.
Show Source
Nested Schema : srcTable-allOf[1]
Type: object
Nested Schema : tablePartition
Type: object
Match All
Show Source
Nested Schema : TablePartition
Type: object
Show Source
Nested Schema : tgtTable-allOf[1]
Type: object

400 Response

Bad Request.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 Response

Unauthorized.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 Response

Not Found.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 Response

Server Error.
Body ()
Root Schema : Error
Type: object
Show Source
Example:
{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}
Back to Top