Oracle Essbase REST API

Essbase URLの取得

get

/essbase/rest/v1/urls

使用可能なEssbase URLのリストを返します。Webインタフェース、Smart Viewクライアント、REST APIなどのEssbaseコンポーネントには、独自のURLの末尾があります。メインURLには、ホスト名またはIPアドレス、ポート番号およびパス/essbase/が含まれます。

デフォルトのセキュア・ポートは、デプロイメント中に変更されていないかぎり、9001です。

リクエスト

この操作にはリクエスト・パラメータはありません。

先頭に戻る

レスポンス

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

application/json
application/xml

200 レスポンス

処理は正常に完了しました。

ルート・スキーマ : Preference

型: object

ソースの表示

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

ソースの表示

配列: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースの表示

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

先頭に戻る

例

次の例では、Essbase URLを取得する方法を示します。

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

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

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/urls -H "Accept:application/json" -u %User%:%Password%

レスポンス本体の例

{
  "items" : [ {
    "application" : "rest",
    "url" : "rest/v1"
  }, {
    "application" : "ui-v1",
    "url" : "ui"
  }, {
    "application" : "ui-v2",
    "url" : "jet"
  }, {
    "application" : "agent",
    "url" : "agent"
  }, {
    "application" : "japi",
    "url" : "japi"
  }, {
    "application" : "xmla",
    "url" : "xmla"
  }, {
    "application" : "smartview",
    "url" : "smartview"
  } ]
}

URLは、様々なEssbaseコンポーネント・エンドポイントに関連しています。

/essbase/rest/v1—Essbase REST APIベースパス。/essbase/rest/docsを使用して、WebブラウザでOpenAPI/Swaggerインタフェースを表示することもできます。
/essbase/ui—Essbase RedwoodスタイルのWebインタフェース。
/essbase/jet—Essbaseクラシック・スタイルのWebインタフェース。
/essbase/agent—Essbase検出URL。これを使用してMaxLクライアントにログインできます。例:
```
login $usrname $passwd on "https://myserver.example.com:9001/essbase/agent";
```
/essbase/japi—Essbase Java API URL (Provider Services URLとも呼ばれる)。
/essbase/xmla—分析用Essbase XML URL。
/essbase/smartview—Essbase Smart ViewクライアントURL。

先頭に戻る