REST API for GoldenGate Veridata

Replace Compare Pair

put

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

Required Role: Administrator, SuperUser, CommandLineOperator

Replace Compare Pair.

Request

Path Parameters

Id(required): integer(int64)

Compare Pair ID.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

columnMappings(required): array columnMappings
columnsSystemMapped: boolean

All the hash columns to be mapped by the veridata system or not. When set to false, it will be user-defined.
delta: object DeltaProcessing

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

Parameter to define if delta processing should be enabled for this Compare Pair or not.
description: string
enabled: boolean

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

All the key columns to be mapped by the veridata system or not. When set to false, it will be user-defined.
profileId: integer (int64)

Default Value: 1

Profile ID.
srcEnscribeInfo: array srcEnscribeInfo
srcRowPartitions: array srcRowPartitions
tgtEnscribeInfo: array tgtEnscribeInfo
tgtRowPartitions: array tgtRowPartitions

{ "properties":{ "profileId":{ "type":"integer", "format":"int64", "default":1, "description":"Profile ID." }, "description":{ "type":"string" }, "enabled":{ "type":"boolean", "description":"Compare pair is enabled in the group to run." }, "deltaProcessingEnabled":{ "type":"boolean", "description":"Parameter to define if delta processing should be enabled for this Compare Pair or not." }, "keyColumnsSystemMapped":{ "type":"boolean", "description":"All the key columns to be mapped by the veridata system or not. When set to false, it will be user-defined." }, "columnsSystemMapped":{ "type":"boolean", "description":"All the hash columns to be mapped by the veridata system or not. When set to false, it will be user-defined." }, "columnMappings":{ "type":"array", "items":{ "$ref":"#/components/schemas/ColumnMapping" } }, "srcRowPartitions":{ "type":"array", "items":{ "$ref":"#/components/schemas/RowPartitionRequest" } }, "tgtRowPartitions":{ "type":"array", "items":{ "$ref":"#/components/schemas/RowPartitionRequest" } }, "delta":{ "$ref":"#/components/schemas/DeltaProcessing" }, "srcEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttributeRequest" } }, "tgtEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttributeRequest" } } }, "required":[ "columnMappings" ], "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" ] } ] } }

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

Array of: object ColumnMapping

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

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 : srcEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttributeRequest

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

Nested Schema : srcRowPartitions

Type: array

Show Source

Array of: RowPartitionRequest

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

Nested Schema : tgtEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttributeRequest

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

Nested Schema : tgtRowPartitions

Type: array

Show Source

Array of: RowPartitionRequest

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

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 : 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 : 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 : RowPartitionRequest

Match All

Show Source

object RowPartitionParams

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

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

Response

Supported Media Types

application/json

200 Response

Ok.

Root Schema : ComparePairInDetails

Type: object

Show Source

srcEnscribeInfo: array srcEnscribeInfo
tgtEnscribeInfo: array tgtEnscribeInfo

{ "allOf":[ { "$ref":"#/components/schemas/ComparePairInDetailsView" }, { "$ref":"#/components/schemas/Group_base" }, { "type":"object" } ], "properties":{ "srcEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttribute" } }, "tgtEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttribute" } } } }

Match All

Show Source

object allOf ComparePairInDetailsView
object Group_base
object ComparePairInDetails-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/ComparePairInDetailsView" }, { "$ref":"#/components/schemas/Group_base" }, { "type":"object" } ], "properties":{ "srcEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttribute" } }, "tgtEnscribeInfo":{ "type":"array", "items":{ "$ref":"#/components/schemas/EnscribeAttribute" } } } }

Nested Schema : srcEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttribute

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

Nested Schema : tgtEnscribeInfo

Type: array

Show Source

Array of: object EnscribeAttribute

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

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 : 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 : Group_base

Type: object

Show Source

group: group

Group Object.

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

Nested Schema : ComparePairInDetails-allOf[2]

Type: object

Nested Schema : EnscribeAttribute

Type: object

Show Source

default: boolean
defaultValue: string
enscribeName: string

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

It is displayed when type is INTEGER.
min: integer

It is displayed when type is INTEGER.
options: string

It is displayed when type is ENUM.
type: string

Allowed Values: [ "BOOLEAN", "ENUM", "INTEGER", "STRING" ]
value: string

{ "type":"object", "properties":{ "enscribeName":{ "$ref":"#/components/schemas/EnscribeAttributeEnum" }, "defaultValue":{ "type":"string" }, "default":{ "type":"boolean" }, "value":{ "type":"string" }, "type":{ "type":"string", "enum":[ "BOOLEAN", "ENUM", "INTEGER", "STRING" ] }, "options":{ "type":"string", "description":"It is displayed when type is ENUM." }, "min":{ "type":"integer", "description":"It is displayed when type is INTEGER." }, "max":{ "type":"integer", "description":"It is displayed when type is INTEGER." } } }

Nested Schema : group

Group Object.

Match All

Group Object.

Show Source

object BaseObject_3
object group-allOf[1]

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

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 : group-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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

Example:

{ "errCode":"OGGV-00001", "errMsg":"Error message" }