1. Oracle EssbaseのREST API
  2. タスク
  3. アプリケーション

アプリケーション名のリスト

get

/essbase/rest/v1/applications/actions/name/{appVisiblity}

リクエストされた可視性のタイプに基づいて、アプリケーション名のリストを返します。たとえば、非表示(シャドウ)アプリケーションのリストのみをフェッチできます。または、表示可能アプリケーションのリストのみや、両方のアプリケーションのセットをフェッチすることもできます。

リクエスト

パス・パラメータ

  • appVisiblity : アプリケーション名の可視性のレベル。有効なオプション: ALL、HIDDEN、REGULAR

    指定可能な値: [ "ALL", "HIDDEN", "REGULAR" ]
先頭に戻る

レスポンス

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

200 レスポンス

OK

アプリケーション名が正常に返されました。

本体()
ルート・スキーマ : Arrays
型: object

400 レスポンス

不正なリクエスト

アプリケーション名の取得に失敗しました。

500 レスポンス

サーバーの内部エラーです。

503 レスポンス

使用できないサービス

ネーミング例外またはサーバー例外。

先頭に戻る

例

次の例では、アプリケーション名をリストする方法を示します。

この例では、cURLを使用して、Windowsシェル・スクリプトからREST APIにアクセスします。呼出し元ユーザーのIDおよびパスワードは変数であり、properties.bat内でその変数値が設定されています。

cURLコマンドを含むスクリプト

この例では、ベース・アプリケーションと非表示のシャドウ・アプリケーション(存在する場合)の両方をレスポンスに含める必要があることを示すためにALLを使用します。

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/actions/name/ALL" -H "accept: application/json" -u %User%:%Password%

レスポンス本体の例

[
  "Sample_Dynamic",
  "SDShadow"
]
先頭に戻る