REST API 開発者ガイド
Spring '26 (API version 66.0)
Winter '25 (API version 62.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Lightning Experience の一連の行動の削除
リッチテキストエリア項目から画像を取得
Blob データを挿入または更新する
blob データの取得
単一の API コールでの連動要求の実行
取引先の更新、取引先責任者の作成、および連結オブジェクトとのリンク
1 回の要求でレコードを更新してその項目値を取得する
取引先の更新/挿入と取引先責任者の作成
ネストされたレコードを作成する
複数のレコードを作成する
Composite Graph の使用
Composite Graph の使用
Composite 要求および Collections 要求の allOrNone パラメーター
複合リソースの使用
このセクションの例では、複合リソースを使用して、クライアントとサーバー間の往復回数を最小限に抑えることでアプリケーションのパフォーマンスを高めます。
-
単一の API コールでの連動要求の実行
次の例では、Composite リソースを使用して、複数の連動要求をすべて単一のコールで実行します。まず取引先を作成してその情報を取得します。次に、取引先データおよび Composite リソースの参照 ID 機能を使用して取引先責任者を作成し、取引先データに基づいて項目に値を入力します。その後、要求文字列でクエリパラメーターを使用して、取引先の所有者に関する特定の情報を取得します。最後に、特定の日付以降メタデータが変更された場合は、取引先のメタデータを取得します。composite.json ファイルには、Composite 要求とサブ要求のデータが含まれます。 -
取引先の更新、取引先責任者の作成、および連結オブジェクトとのリンク
次の例では、Composite リソースを使用して取引先のいくつかの項目を更新し、取引先責任者を作成し、2 つのレコードを AccountContactJunction という連結オブジェクトとリンクします。これらの要求はすべて単一のコールで実行されます。composite.json ファイルには、Composite 要求とサブ要求のデータが含まれます。 -
1 回の要求でレコードを更新してその項目値を取得する
1 回の API コールで複数の要求を実行するには、Composite Batch リソースを使用します。 -
取引先の更新/挿入と取引先責任者の作成
次の例では、Composite リソースを使用して取引先を更新/挿入し、取引先にリンクされた取引先責任者を作成します。これらの要求はすべて単一のコールで実行されます。composite.json ファイルには、Composite 要求とサブ要求のデータが含まれます。 -
ネストされたレコードを作成する
sObject Tree リソースを使用して、ルートレコードタイプを共有するネストされたレコードを作成できます。たとえば、1 回の要求で、取引先とその子取引先責任者、さらに 2 件目の取引先とその子取引先および子取引先責任者を作成できます。要求が処理されると、レコードが作成され、親と子が自動的に ID でリンクされます。要求データに、レコード階層、必須および省略可能な項目値、各レコードのタイプ、および各レコードの参照 ID を指定し、リソースの POST メソッドを使用します。要求が成功すると、レスポンスボディには作成されたレコードの ID が含まれます。失敗すると、応答にはエラーが発生したレコードの参照 ID とエラー情報のみが含まれます。 -
複数のレコードを作成する
リソースを使用してネストされたレコードを作成できますが、同じタイプで複数の関連しないレコードを作成することもできます。1 回の要求で最大 200 件のレコードを作成できます。要求データに、各レコードの必須および省略可能な項目値、各レコードのタイプ、および各レコードの参照 ID を指定し、リソースの POST メソッドを使用します。要求が成功すると、レスポンスボディには作成されたレコードの ID が含まれます。失敗すると、応答にはエラーが発生したレコードの参照 ID とエラー情報のみが含まれます。 -
Composite Graph の使用
Composite Graph により、1 回のコールで一連の REST API 要求を実行する Composite 要求の実行が強化されます。 -
Composite Graph の使用
次の例では、Composite Graph を使用する方法を示します。また、1 つの要求で複数の Composite Graph を使用できる方法も示します。 -
Composite 要求および Collections 要求の allOrNone パラメーター
Composite 要求で sObject Collections を使用している場合、相互にやりとりできる 2 つ以上の allOrNone パラメーターが存在する場合があります。このパラメーターは Composite 要求と各 sObject Collections サブ要求に 1 つずつあります。