sObject Rows by External ID

指定された外部 ID 項目の値に基づいて、新しいレコードを作成するか、既存のレコードを更新 (レコードを Upsert) します。

• 指定された値が存在しない場合、新しいレコードが作成されます。
• 指定された値のレコードが存在する場合、リクエストボディに指定された項目値が更新されます。
• 値が一意でない場合、REST API によって、一致するレコードのリストと共に HTTP 状況コード 300 が返されます。

URI

/vXX.X/sobjects/sObjectName/fieldName/fieldValue

形式

JSON、XML

HTTP メソッド

HEAD、GET、PATCH、DELETE、POST (「使用方法��セクションを参照)

認証

Authorization: Bearer token

パラメータ

なし

使用方法

特殊なケースとして、API バージョン 37.0 以降では、/vXX.X/sobjects/SObjectName/Id に POST することで、このリソースを使用してレコードを作成できます。このパターンは、Id を指定外部 ID 項目として使用し、null を値として使用していることを表しています。これは、異なる外部 ID によって複数のレコードを Upsert するコードを記述していて、個別のリソースを要求したくない場合に役立ちます。

例

• 外部 ID に基づいてレコードを取得する例は、「外部 ID を使用してレコードを取得する」を参照してください。
• 外部 ID に基づいてレコードを作成および更新する例は、「外部 ID を使用してレコードを挿入/更新 (Upsert) する」を参照してください。