GoldenGate Veridata REST API

メタデータを取得します。

post

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

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

カタログ/pdb/スキーマ/表/パーティション/列などのメタデータのリストを返します。

リクエスト

パス・パラメータ

Id(必須): integer(int64)

エージェント接続ID。

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

application/json

ルート・スキーマ: schema

タイプ: object

オブジェクトを定義します。

ソースの表示

catalogName: string
enscribeInfo: array enscribeInfo
filePattern: string

volume.subVolumeのEnscribeファイル・パターン
requestTypes(必須): array requestTypes

カタログ、スキーマ、表、パーティションなどのメタデータ・オブジェクトのタイプ。requestTypeによっては、メタデータを生成するために他のフィールドが必要になります。たとえば、requestTypeがCatalogの場合、追加情報は必要ありませんが、requestTypeがTableの場合はschemaNameが必要となります。requestTypeがTABLEの場合、ビューの詳細もレスポンスで返されます。可能な値 - CATALOG、SCHEMA、TABLE、PARTITION、COLUMN
schemaName: string
tableName: string

{
    "type":"object",
    "description":"Defines an object.",
    "properties":{
        "tableName":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "catalogName":{
            "type":"string"
        },
        "filePattern":{
            "type":"string",
            "description":"Enscribe file pattern of volume.subVolume"
        },
        "requestTypes":{
            "type":"array",
            "description":"Type of metadata object such as  catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response. Possible values - CATALOG, SCHEMA, TABLE, PARTITION, COLUMN",
            "items":{
                "enum":[
                    "CATALOG",
                    "SCHEMA",
                    "TABLE",
                    "PARTITION",
                    "COLUMN"
                ]
            }
        },
        "enscribeInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EnscribeAttributeRequest"
            }
        }
    },
    "example":{
        "tableName":"employee",
        "schemaName":"DEV_SCHEMA",
        "requestTypes":[
            "TABLE"
        ]
    },
    "required":[
        "requestTypes"
    ]
}

例:

{
    "tableName":"employee",
    "schemaName":"DEV_SCHEMA",
    "requestTypes":[
        "TABLE"
    ]
}

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

タイプ: array

ソースの表示

配列: object EnscribeAttributeRequest

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

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

タイプ: array

カタログ、スキーマ、表、パーティションなどのメタデータ・オブジェクトのタイプ。requestTypeによっては、メタデータを生成するために他のフィールドが必要になります。たとえば、requestTypeがCatalogの場合、追加情報は必要ありませんが、requestTypeがTableの場合はschemaNameが必要となります。requestTypeがTABLEの場合、ビューの詳細もレスポンスで返されます。可能な値 - CATALOG、SCHEMA、TABLE、PARTITION、COLUMN

ソースの表示

配列:

指定できる値: [ "CATALOG", "SCHEMA", "TABLE", "PARTITION", "COLUMN" ]

{
    "type":"array",
    "description":"Type of metadata object such as  catalog,schema,table, or partition. Depending on requestType, other fields are needed to generate metadata. For e.g. requestType Catalog will not need any extra information but requestType Table would need schemaName. requestType TABLE returns VIEW details also in response. Possible values - CATALOG, SCHEMA, TABLE, PARTITION, COLUMN",
    "items":{
        "enum":[
            "CATALOG",
            "SCHEMA",
            "TABLE",
            "PARTITION",
            "COLUMN"
        ]
    }
}

ネストされたスキーマ: 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"
        }
    }
}

先頭に戻る

レスポンス

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

application/json

200 レスポンス

メタ・オブジェクトのリスト。

ルート・スキーマ: schema

タイプ: array

ソースの表示

配列: object ResponseMetaDataDefinition

オブジェクトを定義します。

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

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

タイプ: object

オブジェクトを定義します。

ソースの表示

childDataList: object ResponseMetaDataDefinition

オブジェクトを定義します。
datatype: string
datatypeNumber: integer (int64)
name: string
precision: integer (int64)
scale: integer (int64)
view: boolean

{
    "type":"object",
    "description":"Defines an object.",
    "properties":{
        "name":{
            "type":"string"
        },
        "datatype":{
            "type":"string"
        },
        "view":{
            "type":"boolean"
        },
        "precision":{
            "type":"integer",
            "format":"int64"
        },
        "scale":{
            "type":"integer",
            "format":"int64"
        },
        "datatypeNumber":{
            "type":"integer",
            "format":"int64"
        },
        "childDataList":{
            "$ref":"#/components/schemas/ResponseMetaDataDefinition"
        }
    }
}

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

先頭に戻る