REST API for GoldenGate Veridata

Create Compare Pairs

post

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

Required Role: Administrator, SuperUser, CommandLineOperator

API to create Compare Pairs.

Request

Path Parameters

groupId(required): integer(int64)

group ID.

Query Parameters

includeColumnMapping: boolean

Include column mapping details in payload.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

comparePairs: array comparePairs

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

Nested Schema : comparePairs

Type: array

Show Source

Array of: object CreateComparePairRequest

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

Nested Schema : CreateComparePairRequest

Type: object

Show Source

enabled: boolean

Compare Pair is enabled in the group to run.
profileId: integer (int64)

Default Value: 1

Profile ID.
srcEnscribeInfo: array srcEnscribeInfo
srcRowPartitions: array srcRowPartitions
srcTable(required): srcTable

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

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_1"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "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"
                }
            ]
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartitionRequest"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartitionRequest"
            }
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run."
        },
        "srcEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        },
        "tgtEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    },
    "required":[
        "srcTable",
        "tgtTable",
        "name"
    ]
}

Match All

Show Source

object BaseObject_1
object CreateComparePairRequest-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject_1"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "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"
                }
            ]
        },
        "srcRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartitionRequest"
            }
        },
        "tgtRowPartitions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RowPartitionRequest"
            }
        },
        "enabled":{
            "type":"boolean",
            "description":"Compare Pair is enabled in the group to run."
        },
        "srcEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        },
        "tgtEnscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    },
    "required":[
        "srcTable",
        "tgtTable",
        "name"
    ]
}

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

Type: object

Show Source

description: string

Object Description.
name: string

Object Name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Object Name."
        },
        "description":{
            "type":"string",
            "description":"Object Description."
        }
    }
}

Nested Schema : CreateComparePairRequest-allOf[1]

Type: object

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

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

201 Response

Compare Pairs created successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ComparePairInDetails

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

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

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