リクエストの送信

Oracle Essbase REST APIを使用してリクエストを送信する場合は、これらのガイドラインを使用してください。

URL構造

Essbase RESTエンドポイントにアクセスするには、次のURL構造を使用します。

https://base_URL/endpoint-path

この場合:

• endpoint-pathは、RESTリソースを特定する相対パスです。

• base_URLは、IP-address:port/essbase/rest/v1という書式になります。デフォルトのSSLポートは、スタック作成の間に変更された場合を除き、443です。

たとえば、Essbaseインスタンス上のアプリケーションのリストにアクセスするためのURLは、次のようになる可能性があります。

https://myserver.example.com:9001/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