移動

• リクエスト
• レスポンス

比較ペアの取得

get

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

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

比較ペアの詳細を返します。

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  比較ペアID。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

OK。

本文()

ルート・スキーマ: 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." } }, "example":{ "errCode":"OGGV-00001", "errMsg":"Error message" } }

例:

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

例:

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

例:

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

例:

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

先頭に戻る