Anaplan の Bulk API を実行するには、関連アクションを実行する前にいくつかの基本的な情報が必要です。
- Anaplan API のガイドとリファレンスは API 及び Anaplan の用語の基本を理解していることを前提にしています。
- このガイドは、POST、GET 及び PUT API の各コールを含む RESTful API を理解していることを前提にしています。
- 本文書の API の例は Curl コマンドライン ユーティリティを使用するスキルがあることを前提にしています。Curl については、http://curl.haxx.se/ を参照してください。Curl のリクエストに対するレスポンスに HTTP レスポンス コードが確実に含まれるようにするには、オプションの --verbose フラグを追加してください。
- エクスポート、インポート、プロセス、又は削除のアクションを実行するには、Anaplan のモデル ビルダーが実行対象の API 用に適切なアクションを作成する必要があります。
- Anaplan の適切なワークスペースとモデルにアクセスできるユーザーが必要です。 あらゆる問題を適切にトラブルシューティングするために、管理アクセス権があるユーザーに対して API を実行することをおすすめします。
注記:
このガイドで取り上げる API コールは Anaplan アクションの実行サンプルです。 トランザクション API コールについては、https://anaplan.docs.apiary.io/ を参照してください。
Bulk API を使用する手順はアクションによって異なります。 一般的な手順な以下のとおりです。
- 認証トークンを取得する。
- 使用するワークスペースとモデルの ID を取得する。
- アクションを実行するには、関連するアクションを順に実行します。
各 API コールの説明に以下が含まれます。
- メソッド (POST、GET 又は PUT)
- Uniform Resource Identifier (URI) のエンドポイント
- API コールで使用するパラメーター
- Curl コマンドの例
- レスポンスのサンプル