リクエストの送信
Oracle Essbase REST APIを使用してリクエストを送信する場合は、次のガイドラインを使用します。
URL構造
次のURL構造を使用して、Essbase RESTエンドポイントにアクセスします:
https://base_URL/endpoint-path
ここで:
-
endpoint-path
は、RESTリソースを識別する相対パスです。 -
base_URL
の形式は、IP-address:port/essbase/rest/v1
です。 デフォルトのSSLポートは443です(スタックの作成中に変更された場合を除く)。
たとえば、Essbaseインスタンス上のアプリケーションのリストにアクセスするURLは、次のようになります:
https://192.0.2.1:443/essbase/rest/v1/applications
サポートされるメソッド
次の表にまとめているように、標準のHTTPメソッド・リクエストを使用して、リソースに対して基本的なCRUD操作(作成、読取り、更新および削除)を実行できます。
HTTPメソッド | 説明 |
GET |
セッション情報の取得、ユーザーの検索、データベースのリストの取得など、Essbaseリソースに関する情報を取得します。 |
POST |
Essbaseリソースを追加または作成します。たとえば、オブジェクトのロック、ユーザーの追加、データのロードなどです。 |
PUT |
Essbaseリソースを更新します。たとえば、アプリケーション構成の更新、ユーザーまたはグループのプロビジョニング、別名の設定などです。 |
PATCH |
アプリケーション設定の更新やパーティション定義の更新など、既存のEssbaseリソースにパッチを適用します。 |
DELETE |
Essbaseリソースを削除します。たとえば、未使用のフィルタを削除します。 |
メディア・タイプ
操作で特に指定がないかぎり、Essbase REST APIはapplication/json
をサポートします。
サポートされるヘッダー
Essbase REST APIでは、HTTPリクエストまたはレスポンスのヘッダー・セクションで渡すことができる次のヘッダーがサポートされています。
ヘッダー | 説明 | 例 |
Accept-Encoding |
圧縮をサポートする受入れ可能なエンコーディングのリスト。 | Accept-Encoding: gzip |
Content-Encoding |
圧縮をサポートする受入れ可能なエンコーディングのリスト。 | Content-Encoding: deflate |
Content-Type |
リクエストの本文のメディア・タイプ。 POSTおよびPUTリクエストに必要です。 | Content-Type: application/json |