GoldenGate Veridata REST API

比較ペアの作成

post

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

必要なロール: Administrator、SuperUser、CommandLineOperator

比較ペアを作成するAPI。

リクエスト

パス・パラメータ

groupId(必須): integer(int64)

グループID。

問合せパラメータ

includeColumnMapping: boolean

ペイロードに列マッピングの詳細を含めます。

サポートされるメディア・タイプ

application/json

ルート・スキーマ: schema

タイプ: object

ソースの表示

comparePairs: array comparePairs

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

ネストされたスキーマ: comparePairs

タイプ: array

ソースの表示

配列: object CreateComparePairRequest

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

ネストされたスキーマ: CreateComparePairRequest

タイプ: object

ソースの表示

enabled: boolean

実行するグループで比較ペアが有効になります。
profileId: integer (int64)

デフォルト値: 1

プロファイルID。
srcEnscribeInfo: array srcEnscribeInfo
srcRowPartitions: array srcRowPartitions
srcTable(必須): srcTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
tgtEnscribeInfo: array tgtEnscribeInfo
tgtRowPartitions: array tgtRowPartitions
tgtTable(必須): tgtTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

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

すべて一致

ソースの表示

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

ネストされたスキーマ: srcEnscribeInfo

タイプ: array

ソースの表示

配列: object EnscribeAttributeRequest

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

ネストされたスキーマ: srcRowPartitions

タイプ: array

ソースの表示

配列: RowPartitionRequest

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

ネストされたスキーマ: srcTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

すべて一致

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

ソースの表示

object ReqTable

リクエスト本文に表を定義します。
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"
        }
    ]
}

ネストされたスキーマ: tgtEnscribeInfo

タイプ: array

ソースの表示

配列: object EnscribeAttributeRequest

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

ネストされたスキーマ: tgtRowPartitions

タイプ: array

ソースの表示

配列: RowPartitionRequest

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

ネストされたスキーマ: tgtTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

すべて一致

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。

ソースの表示

object ReqTable

リクエスト本文に表を定義します。
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"
        }
    ]
}

ネストされたスキーマ: BaseObject_1

タイプ: object

ソースの表示

description: string

オブジェクトの説明。
name: string

オブジェクト名。

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

ネストされたスキーマ: CreateComparePairRequest-allOf[1]

タイプ: object

ネストされたスキーマ: EnscribeAttributeRequest

タイプ: object

ソースの表示

default: boolean
name: string

指定できる値: [ "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"
        }
    }
}

ネストされたスキーマ: RowPartitionRequest

すべて一致

ソースの表示

object RowPartitionParams

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

ネストされたスキーマ: RowPartitionParams

タイプ: object

ソースの表示

endingKey: string

Enscribe終了キー。
isAscii: boolean

EnscribeはASCIIです。
name(必須): string
runtime: boolean

実行時に使用します。
startingKey: string

Enscribe開始キー。
type(必須): string

指定できる値: [ "S", "E", "A" ]

行パーティションのタイプ(SQL{S}、Enscribe{E}、自動{A})
whereClause: string

SQL述語文。

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

ネストされたスキーマ: ReqTable

タイプ: object

リクエスト本文に表を定義します。

ソースの表示

catalog: string
filePattern: string

NSK Enscribeデータベースに有効です。
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"
                }
            ]
        }
    }
}

ネストされたスキーマ: srcTable-allOf[1]

タイプ: object

ネストされたスキーマ: tablePartition

タイプ: object

すべて一致

ソースの表示

object TablePartition

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/TablePartition"
        }
    ]
}

ネストされたスキーマ: TablePartition

タイプ: object

ソースの表示

name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: tgtTable-allOf[1]

タイプ: object

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

201 レスポンス

比較ペアが正常に作成されました。

ルート・スキーマ: schema

タイプ: array

ソースの表示

配列: object ComparePairInDetails

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

ネストされたスキーマ: ComparePairInDetails

タイプ: object

ソースの表示

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

すべて一致

ソースの表示

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

ネストされたスキーマ: srcEnscribeInfo

タイプ: array

ソースの表示

配列: object EnscribeAttribute

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

ネストされたスキーマ: tgtEnscribeInfo

タイプ: array

ソースの表示

配列: object EnscribeAttribute

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

ネストされたスキーマ: ComparePairInDetailsView

タイプ: object

ソースの表示

columnMappings: array columnMappings
columnsSystemMapped: boolean

デフォルト値: true

キー列システムがマップされているかどうか。
delta: delta
deltaProcessingEnabled: boolean

デフォルト値: false

この比較ペアに対してデルタ処理が有効になります。
enabled: boolean

デフォルト値: true

実行するグループで比較ペアが有効になります。
keyColumnsSystemMapped: boolean

デフォルト値: true

キー列システムがマップされているかどうか。
profile: profile

プロファイル・オブジェクト。
setting: object ComparePairSetting

表内の列のマッピング。
srcIndexName: string
srcRowPartitions: array srcRowPartitions
srcTable: srcTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
tgtIndexName: string
tgtRowPartitions: array tgtRowPartitions
tgtTable: tgtTable

比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
validationStatus: string

指定できる値: [ "NeverValidated", "Validated" ]

比較ペア検証ステータスの列挙。
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"
        }
    }
}

すべて一致

ソースの表示

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

ネストされたスキーマ: BaseObject_2

タイプ: object

ソースの表示

createdOn: string (date-time)

パターン: YYYY-MM-DDTHH:mm:ss.sssZ

例: 2024-02-03T10:15:30Z
id: integer (int64)

オブジェクトID。
name: string

オブジェクト名。
updatedOn: string (date-time)

パターン: YYYY-MM-DDTHH:mm:ss.sssZ

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

ネストされたスキーマ: ComparePairInDetailsView-allOf[1]

タイプ: object

ネストされたスキーマ: Group_base

タイプ: object

ソースの表示

group: group

グループ・オブジェクト。

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

ネストされたスキーマ: ComparePairInDetails-allOf[2]

タイプ: object

ネストされたスキーマ: EnscribeAttribute

タイプ: object

ソースの表示

default: boolean
defaultValue: string
enscribeName: string

指定できる値: [ "AltKey", "Dictionary", "Record", "ExpandDDLRedefs", "ExpandDDLResolveDupAppend", "ExpandDDLResolveDupPrepend", "ExpandDDLExpandGroupArrays", "ExpandDDLFixLongNames", "ExpandDDLMaxColNameLen", "ExpandDDLSeparator", "ExpandDDLZeroFill" ]
max: integer

型がINTEGERの場合に表示されます。
min: integer

型がINTEGERの場合に表示されます。
options: string

タイプがENUMの場合に表示されます。
type: string

指定できる値: [ "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."
        }
    }
}

ネストされたスキーマ: group

グループ・オブジェクト。

すべて一致

グループ・オブジェクト。

ソースの表示

object BaseObject_3
object group-allOf[1]

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

ネストされたスキーマ: BaseObject_3

タイプ: object

ソースの表示

id: integer (int64)

オブジェクトID。
name: string

オブジェクト名。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Object Id.",
            "format":"int64"
        },
        "name":{
            "type":"string",
            "description":"Object Name."
        }
    }
}

ネストされたスキーマ: group-allOf[1]

タイプ: object

400 レスポンス

不正なリクエスト。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

401 レスポンス

権限がありません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

404 レスポンス

見つかりません。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

500 レスポンス

サーバー・エラー。

ルート・スキーマ: Error

タイプ: object

ソースの表示

errCode: string

Veridataのエラー・コード。
errMsg: string

Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    }
}

先頭に戻る