移動

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

グループ詳細の取得

get

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

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

Veridataグループの詳細を取得します。

リクエスト

パス・パラメータ

• Id(必須): integer

問合せパラメータ

• name: string
  相似する比較ペア名。
• profile: string
  相似する比較ペア・プロファイル。
• srcTable: string
  相似するソース表名。
• status:
  比較ペアの検証ステータス。
• tgtTable: string
  相似するターゲット表名。

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

先頭に戻る

レスポンス

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

• application/json
• */*

200 レスポンス

グループが正常に返されました。

本文()

ルート・スキーマ: Group

タイプ: object

ソースの表示

• comparePairs: array comparePairs
• sourceConnection: GroupConnection
• targetConnection: GroupConnection

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "sourceConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "targetConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComparePairForGroupDetails"
            }
        }
    }
}

すべて一致

ソースの表示

• object BaseObject
• object Group-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/BaseObject"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "sourceConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "targetConnection":{
            "$ref":"#/components/schemas/GroupConnection"
        },
        "comparePairs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ComparePairForGroupDetails"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: object ComparePairForGroupDetails

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

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

タイプ: object

ソースの表示

• id: integer (int64)
  ソース接続ID。
• name: string

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Source Connection ID."
        },
        "name":{
            "type":"string"
        }
    }
}

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

タイプ: object

ソースの表示

• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• description: string
  オブジェクトの説明。
• 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."
        },
        "description":{
            "type":"string",
            "description":"Object Description."
        },
        "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"
        }
    }
}

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

タイプ: object

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

タイプ: object

ソースの表示

• deltaProcessingEnabled: boolean
  デフォルト値: false

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

  実行するグループで比較ペアが有効になります。
• groupId: integer (int64)
  グループID。
• name: string
• profileId: integer (int64)
  デフォルト値: 1

  プロファイルID。
• srcTable: object srcTable
  比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
• tgtTable: object tgtTable
  比較ペアの表、および表と行のパーティションの情報(ある場合)を表します。
• validationStatus: string
  指定できる値: [ "NeverValidated", "Validated" ]

  比較ペア検証ステータスの列挙。
• validationTime: string (date-time)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "profileId":{
            "type":"integer",
            "format":"int64",
            "default":"1",
            "description":"Profile ID."
        },
        "groupId":{
            "type":"integer",
            "format":"int64",
            "description":"Group ID."
        },
        "srcTable":{
            "type":"object",
            "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
            "properties":{
                "name":{
                    "type":"string"
                },
                "schema":{
                    "type":"string"
                },
                "catalog":{
                    "type":"string"
                }
            }
        },
        "tgtTable":{
            "type":"object",
            "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
            "properties":{
                "name":{
                    "type":"string"
                },
                "schema":{
                    "type":"string"
                },
                "catalog":{
                    "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"
        }
    }
}

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

タイプ: object

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

ソースの表示

• catalog: string
• name: string
• schema: string

{
    "type":"object",
    "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        }
    }
}

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

タイプ: object

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

ソースの表示

• catalog: string
• name: string
• schema: string

{
    "type":"object",
    "description":"Represents a table in Compare Pair with table and row partitions info, if any.\n",
    "properties":{
        "name":{
            "type":"string"
        },
        "schema":{
            "type":"string"
        },
        "catalog":{
            "type":"string"
        }
    }
}

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

先頭に戻る