OData は、ウェブ上でデータを公開および使用するためのベスト プラクティス アプローチであり、一貫した一連の規則と操作を使用して、Anaplan Financial Consolidation などのデータ ソースを操作できるようにします。
Open Data Protocol (OData) は、RESTful API の構築と使用に関するベスト プラクティスを定義する OASIS 標準です。OData 準拠のエンドポイントは、統一された操作とクエリ オプションを定義することにより、さまざまなシステムとプラットフォーム間の相互運用性を促進します。
Anaplan Financial Consolidation API では、OData エンドポイントは、HTTP メソッドを使用してクライアント スキーマ ステージング テーブルでデータを取得、挿入、更新、削除できます。サポートされているメソッドは以下のとおりです。
- GET: 単一のスキーマ テーブルから情報を取得します。
- POST: クライアント スキーマ テーブルにデータを挿入します。
- PUT: クライアント スキーマ テーブル内の一つ以上の行を更新します。
- DELETE: クライアント スキーマ テーブルから一つ以上の行を削除するか、スキーマ全体を維持しながらテーブルの内容をクリアします。
ヘッダーと本文のデータ
OData エンドポイントへのすべてのリクエストには、テナントと有効な API トークンが含まれている必要があります。サーバーでは、残りのリクエストを処理するためにこのトークンを認証する必要があります。リクエストでは、パラメーターの交差を指定するか、テーブル全体をアドレス指定する必要もあります。これはリクエストのヘッダーと本文で行われ、個々のリクエストごとに記述されます。
パラメーターのデータ型
OData エンドポイントのパラメーターにはさまざまなデータ型を使用できます。Anaplan Financial Consolidation では次の標準データ型をサポートしています。
データ型 | 説明 | 例 |
string | 文字と数字の英数字のシーケンス。 | { |
integer | 整数 (正と負のいずれか)。 | { |
boolean | 二つのオプションのいずれかを表す値 (通常は TRUE か FALSE)。 | True の場合は 1 、False の場合は 0 |