Oracle Analytics CloudのためのREST API

接続の詳細の取得

get

/api/20210901/catalog/connections/{connectionId}

指定されたIDの既存の接続の詳細を返します。たとえば、所有者、名前、説明、ID、最終変更日、オブジェクト・タイプ、親IDなどの詳細です。 'content'が問合せパラメータ'fields'を介してリクエストされた場合、接続'content'も返されます。

リクエスト

パス・パラメータ

connectionId(required): string(byte)

Base64URLエンコーディングを使用した接続のID。たとえば、接続にオブジェクトID 'user'がある場合、'connId'にBase64URLでエンコードされた値J3VzZXInLidjb25uSWQnを入力します

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作。

ルート・スキーマ: schema

Type: object

400レスポンス

接続でエンコードされたIDが無効です

ルート・スキーマ: 400BadRequest

不正なリクエスト(無効な問合せパラメータ、不正なヘッダーなど)。

403レスポンス

接続を表示する権限がありません

ルート・スキーマ: 403Forbidden

禁止(操作の権限がない、不明な理由によりリクエストが拒否されたなど)。

500レスポンス

内部サーバー・エラー。サーバーで予期しない状態が発生したため、リクエストを実行できませんでした。

ルート・スキーマ: Error

Type: object

ソースを表示

code(必須): string

プログラム解析のためのエラーを定義する短いエラー・コード。
message(必須): string

判読可能なエラー文字列。

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Short error code that defines the error, meant for programmatic parsing.\n"
        },
        "message":{
            "type":"string",
            "description":"Human-readable error string.\n"
        }
    },
    "required":[
        "code",
        "message"
    ]
}

先頭に戻る

例

これらの例は、特定のIDを持つ接続の詳細を返す方法を示しています。

例1 - フィールド基準なし
例2 - 複数のフィールド基準

例1 - フィールド基準なし

この例では、返すフィールドを指定せずに、指定されたIDを持つ既存の接続の詳細を返します。フィールドを一覧表示すると、content以外のすべての詳細が返されます。接続のオブジェクトIDは、Base64URLでエンコードされたID値を持つ'Admin'.'oracle_adw_walletless'です: J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==。「タイプ別のカタログ項目の取得」を使用して、接続のIDを取得できます。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    \
         --request GET 'https://<hostname>/api/20210901/catalog/connection/J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw=='

リクエスト本文の例

Not applicable.

レスポンス本文の例

{   
    "owner": "admin",    
    "name": "oracle_adw_walletless",
    "description": "Sample Oracle ADW connection without a wallet created using Connections API",
    "id": "J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==",
    "last modified": "2025-01-01T19:53:07Z",
    "type": "connections",
    "parent": "L29yYWNsZUNvbm5lY3Rpb25zLw",
}

例2 - 複数のフィールド基準

この例では、指定されたIDを持つ既存の接続の詳細を返します。返される詳細は、?fields=の後にリストされたフィールド(この場合は接続名、説明およびコンテンツの詳細)によって決まります。接続のオブジェクトIDは、Base64URLでエンコードされたID値を持つ'Admin'.'oracle_adw_walletless'です: J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==。

cURLの例:

curl    --header 'Authorization: Bearer <token>'    \
         --request GET 'https://<hostname>/api/20210901/catalog/connections/J0FkbWluJy4nb3JhY2xlX2Fkd193YWxsZXRsZXNzJw==?fields=name,description,content'

リクエスト本文の例

Not applicable.

レスポンス本文の例

{
    "name": "oracle_adw_walletless",
    "description": "Sample Oracle ADW connection without a wallet created using Connections API",    
    "content": "<connections-content>"
}

先頭に戻る