管理 API:詳細計画のインポートとエクスポート
詳細計画をエクスポートしてバックアップしたり、詳細計画をエクスポートおよびインポートして 1 つの CPQ 環境から別の環境に移動したりできます。
CPQ 詳細計画管理 API は、詳細計画を操作するためのインポートおよびエクスポート API 呼び出しを提供します。一般的なユースケースには、 CPQ 環境間での詳細計画の移行や詳細計画のバックアップなどがあります。CPQブループリント管理 API を表示するには、以下を参照してください。
すべての CPQ API の包括的なリストについては、「 CPQ API リファレンス」を参照してください。
https://api-docs.logik.io/#introduction
Github で CPQ オープンソース API ドキュメントを表示することもできます。
https://github.com/logikioopensource/API-Documentation
詳細計画 API を呼び出すための管理 API キーを設定する方法については、以下を参照してください。
詳細計画エクスポート API
API を介して詳細計画をエクスポートする場合、詳細計画のエクスポート呼び出しは詳細計画の変数名を渡してエクスポートジョブを開始します。応答として、コールは、ステータスを取得し、詳細計画を ZIP ファイルとしてダウンロードするために照会できるジョブ ID を受け取ります。
詳細計画をエクスポートおよびダウンロードするための API 呼び出しのシーケンスは次のとおりです。
- 詳細計画のエクスポート
ペイロードの詳細計画変数を使用してエクスポートを開始します。ジョブ ID をポーリングしてエクスポートのステータスを確認できます。
- ジョブステータスを確認
ステータスを確認するには、エクスポート呼び出し後に返されたジョブ ID を使用します。ステータスが「完了」になったら、ステップ 3 に進みます。
- エクスポートをダウンロード
同じジョブ ID を使用して、詳細計画を含む ZIP ファイルをダウンロードします。
詳細計画のエクスポートコールのソースコードを表示するには、以下を参照してください。
詳細計画インポート API
詳細計画をインポートするために、詳細計画のインポートコールは詳細計画の ZIP ファイルを渡してインポートジョブを開始します。
詳細計画をインポートするための API 呼び出しのシーケンスは次のとおりです。
- 詳細計画のインポート
詳細計画を含む ZIP ファイルを選択します。ジョブ ID をポーリングしてインポートのステータスを確認できます。
- ジョブステータスの確認
ステータスを確認するには、インポート呼び出し後に返されたジョブ ID を使用します。ステータスが [成功] の場合、ジョブは完了です。
詳細計画のインポートコールのソースコードを表示するには、以下を参照してください。