バージョン情報

製品	バージョン
EBX	6.2.0

概要

本記事では、EBXにおけるRESTリクエストとレスポンスの基本形式について解説します。

EBXのRESTリクエストのURLは、いずれのリクエストにおいても下記のように示されます。

http[s]://<host>[:<port>]/<ebx-dataservices>/rest/{category}/{categoryVersion}/{specificPath}[:{extendedAction}]?{queryParameters}

ここで、ポート以下の各要素は下記を意味します。

要素	説明
ebx-dataservices	ebx-dataservices.warが格納されている、../tomcat-9.X.X/webapps/ 以下のパスを指します。通常は"ebx-dataservices"のみです。
category	REST APIを通じて行うリクエストの種類です。（下記参照「リクエストの種類」）
categoryVersion	上記操作カテゴリのバージョンを指します。現在は"v1"で固定です。
specificPath	リクエストを行う対象のパスを指します。
extendedAction	リクエストに追加でアクションを指定できる場合は、この位置に記載します。
queryParameters	リクエストに追加でパラメーターを指定できる場合は、この位置に記載します。

リクエストの種類（上記URLのcategoryに記載）は、下記の通り

要素	説明
admin	管理系の操作を行う際に使用します。（例：EBXユーザー/ロール情報、システム情報の取得）
auth	認証系の操作を行う際に使用します。（例：トークンの生成、パスワードの変更）
data/data-compact	データセット、テーブル、レコードにおける各操作を行う際に使用します。
data-bo/data-compact-bo	ビジネスオブジェクトを通じたレコード操作に使用します。
form-data/form-data-compact	レコードの登録/更新時に使用します。上記"data"とは異なり、登録/更新を行う前に行ったバリデーションの結果レポートを、リクエストのレスポンスとして返却します。
health	ヘルスチェックを行う際に使用します。
history	データの履歴に関する情報を取得する際に使用します。
api	指定したリソースのOpenAPIドキュメントを生成します。

要素	説明
Accept	レスポンスに使用されるコンテンツタイプを指定します。現在サポートされているのは、application/jsonのみとなります。
Accept-Language	レスポンスに使用されるロケールを指定します。指定したロケールが存在しない場合は、デフォルトのロケールが使用されます。
Authorization	認証情報を記載します。
Content-Type	リクエストのボディに使用されるメディアタイプを指定します。現在サポートされているのは、application/json または application/x-www-form-urlencoded です。サポートされていないタイプを指定した場合、415エラーが返されます。
X-Requested-With	このヘッダーが設定されている場合、認証失敗の際に、WWW-Authenticateヘッダーがレスポンスに付与されません。

要素

説明

disableRedirectionToLastBroadcast

D3構成をとる場合にのみ有効なパラメータです。

tureの場合、プライマリノード上で配信されるデータスペースへのアクセスは、最終配信時のスナップショットへとリダイレクトされません。デフォルトはfalseです。

ebx-channel

リクエスト送信時のEBXへの接続チャネルを指定します。接続チャネルとデータモデル上で設定されているvisibilityに応じて、操作できるデータが異なります。指定できる値は、dataServices または ui のみです

レスポンスは、送信したリクエストに応じてボディの内容が変わるため、本稿ではレスポンスヘッダーのみ解説します。

要素	説明
Content-Language	レスポンスに使用されるロケールを示します。
Content-Type	レスポンスボディのコンテンツタイプを示します。
Location	新規レコードの追加がなされた場合に、そのレコードへのクエリURLを示します。
WWW-Authenticate	Basic認証による認証かつリクエストに”X-Requested-With”ヘッダーが設定されていない状況で認証に失敗した場合に、401エラーとともにこのヘッダーが付与されます。値はEBXで固定です。