メインコンテンツへスキップ
日本語版はAIによる翻訳です。正確な情報については英語版をご参照ください。
このガイドでは、Treatment Management APIのすべての機能について説明します。

ヘッダー

名前型説明
x-api-keyStringAuxiaを利用するプロジェクトまたは企業ごとに発行される、文字列形式のAPIキーです。このAPIキーには、このAPIを呼び出す権限が必要です。 ヘッダーに設定してください。

ステータスコード

  1. 200: OK。
  2. 400: Invalid Request。エラーの詳細を確認し、リクエストを適宜修正してください。
  3. 403: Forbidden。正しいAPIキー、projectId、その他のパラメーターがリクエストに含まれていることを確認してください。
エラーレスポンスの形式、すべてのステータスコード、リトライのガイダンスについてはエラーを参照してください。

1. Insert/Update Treatment(トリートメントの登録・更新)

APIを通じてトリートメント(施策)を登録・更新できます。詳細はこちらをご覧ください。

2. Insert/Update Treatment Type(トリートメントタイプの登録・更新)

APIを通じてトリートメントタイプを登録・更新できます。詳細はこちらをご覧ください。

3. Get DataFields(データフィールドの取得)

APIを通じてデータフィールドを取得できます。詳細はこちらをご覧ください。

4. Get All Treatments(全トリートメントの取得)

フィルター条件を指定して、プロジェクトのすべてのトリートメントを取得できます。詳細はこちらをご覧ください。

5. Get Treatment(トリートメントの取得)

トリートメントIDを指定して、単一のトリートメントを取得できます。詳細はこちらをご覧ください。

6. Insert DataField(データフィールドの登録)

APIを通じてデータフィールドを登録できます。詳細はこちらをご覧ください。

7. Insert Surface(サーフェスの登録)

APIを通じてサーフェス(表示面)を登録できます。詳細はこちらをご覧ください。