ジャンプ先

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

すべての外部キーの取得

get

/database/objects/foreign_keys/

実行時のロールに応じてDBA_CONSTRAINTSビューとDBA_CONS_COLUMNSビュー、またはALL_CONSTRAINTSビューとALL_CONS_COLUMNSビューから、制約タイプがRであるすべてのレコードを返します。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

問合せパラメータ

• limit: integer(int32)
  戻すレコードの最大数。
• q:
  フィルタリングは、全コレクションで見つかった項目のサブセットが含まれている複数ページのリソース全体に対し、リクエストごとの動的フィルタ定義を使用してコレクション・リソースを制限する処理です。フィルタリングは、大規模なコレクションの効率的な走査を可能にします。

  例

  例の選択 FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

データベース内のすべての表について、制約タイプ 'R'のすべての制約定義を説明します。

本文 ()

ルート・スキーマ: DatabaseObjectsForeignKeys

タイプ: object

ソースの表示

• count: integer
  現在のレスポンス内のレコードの合計数
• hasMore: boolean
  取得するレコードがさらにあるかどうか
• items: array items
• limit: integer
  サーバーによって適用されるレコード数に関する実際のページ・サイズ制限
• links: array links
• offset: integer
  項目リソースの返戻元となる実際の索引

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatabaseObjectsForeignKeysItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト DatabaseObjectsForeignKeysItem
  参照整合性の外部キー制約を説明します。

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

参照整合性の外部キー制約を説明します。

ソースの表示

• columns: object columns
  所有者constraint_nameを参照するすべての列について説明します。
• constraint_name: string
  制約定義の所有者。
• constraint_type: string
  制約の種類。
• links: array links
• owner: string
  制約定義の所有者。
• r_constraint_name: string
  制約定義の所有者。
• r_owner: string
  参照制約で参照される表の所有者
• table_name: string
  制約定義付きの表(またはビュー)に対応付けられた名前

{
    "type":"object",
    "description":"Describes a foreign key constraint for referential integrity.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "constraint_type":{
            "type":"string",
            "description":"Type of constraint."
        },
        "table_name":{
            "type":"string",
            "description":"Name associated with the table (or view) with the constraint definition."
        },
        "r_owner":{
            "type":"string",
            "description":"Owner of the table referred to in a referential constraint."
        },
        "r_constraint_name":{
            "type":"string",
            "description":"Owner of the constraint definition."
        },
        "columns":{
            "type":"object",
            "description":"Describes all the columns that make reference to  owner, constraint_name.",
            "properties":{
                "r_column_name":{
                    "type":"string",
                    "description":"Name of the column referred to in a referential constraint."
                },
                "r_table_name":{
                    "type":"string",
                    "description":"Name of the table referred to in a referential constraint."
                },
                "column_name":{
                    "type":"string",
                    "description":"Name of the column or attribute of the object type column specified in the constraint definition."
                },
                "position":{
                    "type":"integer",
                    "description":"The position of the column_name and referenced r_column_name."
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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

タイプ: object

所有者constraint_nameを参照するすべての列について説明します。

ソースの表示

• column_name: string
  制約定義に指定されているオブジェクト型の列に対する列名または属性名。
• position: integer
  column_nameおよび参照されるr_column_nameの位置
• r_column_name: string
  参照制約で参照される列の名前
• r_table_name: string
  参照制約で参照される表の名前

{
    "type":"object",
    "description":"Describes all the columns that make reference to  owner, constraint_name.",
    "properties":{
        "r_column_name":{
            "type":"string",
            "description":"Name of the column referred to in a referential constraint."
        },
        "r_table_name":{
            "type":"string",
            "description":"Name of the table referred to in a referential constraint."
        },
        "column_name":{
            "type":"string",
            "description":"Name of the column or attribute of the object type column specified in the constraint definition."
        },
        "position":{
            "type":"integer",
            "description":"The position of the column_name and referenced r_column_name."
        }
    }
}

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

ソースの表示

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る