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

Replace Compare Pair

put

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

Required Role: Administrator, SuperUser, CommandLineOperator

Replace Compare Pair.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Example:
{
    "profileId":"1,",
    "description":"Updated employee compare pair,",
    "enabled":"true,",
    "deltaProcessingEnabled":"true,",
    "keyColumnsSystemMapped":"true,",
    "columnsSystemMapped":"true,",
    "columnMappings":[
        {
            "srcColumn":[
                {
                    "columnName":"ID,",
                    "dataType":"NUMBER,",
                    "lob":false
                }
            ]
        },
        {
            "tgtColumn":[
                {
                    "columnName":"ID,",
                    "dataType":"NUMBER,",
                    "lob":false
                }
            ]
        }
    ],
    "compareFormat":"number,",
    "mappingType":"key,",
    "supportedCompareFormats":[
        "string, string_en, dec_float, float, binary"
    ],
    "srcRowPartitions":[
        {
            "name":"employee Id's greater than 100,",
            "whereClause":"ID > 100,",
            "type":"S,",
            "runTime":true
        }
    ],
    "tgtRowPartitions":[
        {
            "name":"employee Id's greater than 100,",
            "whereClause":"ID > 100,",
            "type":"S,",
            "runTime":true
        }
    ],
    "delta":[
        {
            "srcColumn":"MODIFIED_DATE,",
            "tgtColumn":"MODIFIED_DATE,",
            "srcDeltaQuery":"SELECT MAX(MODIFIED_DATE) FROM ORCL1.VERIDATA.EMPLOYEE,",
            "tgtDeltaQuery":"SELECT MAX(MODIFIED_DATE) FROM ORCL1.VERIDATA.EMPLOYEE,",
            "srcDeltaCols":[
                "MODIFIED_DATE, CREATED_DATE"
            ],
            "tgtDeltaCols":[
                "MODIFIED_DATE, CREATED_DATE"
            ]
        }
    ]
}
Nested Schema : columnMappings
Type: array
Show Source
Nested Schema : DeltaProcessing
Type: object
Defines Delta Setting. For NSK this will be an empty object.
Show Source
Nested Schema : srcEnscribeInfo
Type: array
Show Source
Nested Schema : srcRowPartitions
Type: array
Show Source
Nested Schema : tgtEnscribeInfo
Type: array
Show Source
Nested Schema : tgtRowPartitions
Type: array
Show Source
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 : srcDeltaCols
Type: array
List of Source Delta columns.
Show Source
Nested Schema : tgtDeltaCols
Type: array
List of Target Delta columns.
Show Source
Nested Schema : EnscribeAttributeRequest
Type: object
Show Source
  • Allowed Values: [ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
Nested Schema : RowPartitionRequest
Match All
Show Source
Nested Schema : RowPartitionParams
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Ok.
Body ()
Root Schema : ComparePairInDetails
Type: object
Show Source
Match All
Show Source
Nested Schema : srcEnscribeInfo
Type: array
Show Source
Nested Schema : tgtEnscribeInfo
Type: array
Show Source
Nested Schema : ComparePairInDetailsView
Type: object
Show Source
Match All
Show Source
Nested Schema : BaseObject_2
Type: object
Show Source
Nested Schema : ComparePairInDetailsView-allOf[1]
Type: object
Nested Schema : Group_base
Type: object
Show Source
Nested Schema : ComparePairInDetails-allOf[2]
Type: object
Nested Schema : EnscribeAttribute
Type: object
Show Source
Nested Schema : group
Group Object.
Match All
Group Object.
Group Object.
Show Source
Nested Schema : BaseObject_3
Type: object
Show Source
Nested Schema : group-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