ジャンプ先

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

データベースのすべてのシノニムの取得

get

/database/objects/synonyms/

実行時のロールに応じてDBA_SYNONYMSビューまたはALL_SYNONYMSビュー内のすべてのレコードを返します。クライアントは、このサービスを起動するにはSQL管理者ロールまたはSQL開発者ロールが必要です。

リクエスト

問合せパラメータ

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

  例

  例の選択 FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

DBA_SYNONYMSビューまたはALL_SYNONYMSビューを使用して、データベース内のすべてのシノニムについて説明します。

本文 ()

ルート・スキーマ: DatabaseObjectsSynonyms

タイプ: 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/DatabaseObjectsSynonymsItem"
            }
        },
        "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

ソースの表示

• 配列: オブジェクト DatabaseObjectsSynonymsItem
  このオブジェクトは、データベース内の1つのシノニムについて説明します。属性のリストは、データベースのバージョンによって異なる場合があります。

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

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

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

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

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

タイプ: object

このオブジェクトは、データベース内の1つのシノニムについて説明します。属性のリストは、データベースのバージョンによって異なる場合があります。

ソースの表示

• db_link: string
  参照されるデータベース・リンクの名前(ある場合)。
• links: array links
• origin_con_id: integer
  データの発生元のコンテナのID。
• owner: string
  シノニムの所有者。
• synonym_name: string
  シノニムの名前。
• table_name: string
  シノニムが参照するオブジェクトの名前。列名はTABLE_NAMEですが、オブジェクトが表である必要はありません。ビュー、順序、ストアド・プロシージャ、シノニムなどの一般的なオブジェクトにできます。
• table_owner: string
  シノニムによって参照されているオブジェクトの所有者、またはターゲットがパブリック・シノニムである場合に参照するシノニムの作成者(TABLE_NAMEによって参照されるオブジェクト)。列名はTABLE_OWNERですが、所有オブジェクトが表である必要はありません。ビュー、順序、ストアド・プロシージャ、シノニムなどの一般的なオブジェクトにできます。

{
    "type":"object",
    "description":"This object describes a synonym in the database. The list of attributes may vary depending on database version.",
    "properties":{
        "owner":{
            "type":"string",
            "description":"Owner of the synonym."
        },
        "synonym_name":{
            "type":"string",
            "description":"Name of the synonym."
        },
        "table_owner":{
            "type":"string",
            "description":"Owner of the object referenced by the synonym, or creator of the referring synonym if the target is a public synonym (that is, the object referred to by TABLE_NAME). Although the column is called TABLE_OWNER, the object owned is not necessarily a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on."
        },
        "table_name":{
            "type":"string",
            "description":"Name of the object referenced by the synonym. Although the column is called TABLE_NAME, the object does not necessarily have to be a table. It can be any general object such as a view, sequence, stored procedure, synonym, and so on."
        },
        "db_link":{
            "type":"string",
            "description":"Name of the database link referenced, if any."
        },
        "origin_con_id":{
            "type":"integer",
            "description":"The ID of the container where the data originates."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

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

先頭に戻る