Web API を使用してテーブル行を更新および削除する

2025-10-04

データを変更する操作は、Web API の中核となる部分です。単純な更新操作と削除操作に加えて、1 つのテーブル列 (エンティティ属性) に対して操作を実行し、存在するかどうかに応じてデータを更新または挿入する アップサート 要求を作成できます。

基本的な更新

更新操作では、HTTP PATCH 動詞を使用します。更新するプロパティを含む JSON オブジェクトを、レコードを表す URI に渡します。更新が成功した場合、 204 No Content 状態の応答が返されます。

If-Match: * ヘッダーを使用すると、誤ってアップサート操作を実行して新しいレコードを作成しないようにします。詳細情報: アップサートでの作成を禁止します。

Important

エンティティを更新する場合は、変更するプロパティのみを要求本文に含めます。以前に取得したエンティティのプロパティを更新し、その JSON を要求に含めるだけで、値が同じであっても各プロパティが更新されます。これにより、値が変更されたことを予期するビジネスロジックをトリガーできるシステムイベントが発生する可能性があります。これにより、実際に変更されていない場合に、監査データでプロパティが更新されたように見える可能性があります。

statecode プロパティを更新するときは、常に目的のstatuscodeを設定することが重要です。 statecode と statuscode には依存値があります。特定のstatuscode値には複数の有効なstatecode値を指定できますが、各statecode列には 1 つの DefaultStatus 値が構成されています。 statecodeを指定せずにstatuscodeを更新すると、システムによって既定の状態値が設定されます。また、テーブルと statuscode 列で監査が有効になっている場合、更新操作で指定されていない限り、 statuscode 列の変更された値は監査データにキャプチャされません。

注

属性の定義には、 RequiredLevel プロパティが含まれています。これが SystemRequired に設定されている場合、これらの属性を null 値に設定することはできません。詳細情報: 属性要件レベル

次の使用例は、 accountid 値が 000000000-0000-0000-0000-000000000001 の既存の取引先企業レコードを更新します。

要求:

PATCH [Organization URI]/api/data/v9.2/accounts(00000000-0000-0000-0000-000000000001) HTTP/1.1  
Content-Type: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0
If-Match: *  
  
{  
    "name": "Updated Sample Account ",  
    "creditonhold": true,  
    "address1_latitude": 47.639583,  
    "description": "This is the updated description of the sample account",  
    "revenue": 6000000,  
    "accountcategorycode": 2  
}

応答：

HTTP/1.1 204 No Content  
OData-Version: 4.0

注

更新時のエンティティの関連付けと関連付けの解除については、「単一値ナビゲーションプロパティの使用」を参照してください。

返されたデータで更新する

更新するエンティティからデータを取得するには、作成されたレコードのデータが 200 (OK) の状態で返されるように、 PATCH 要求を作成できます。この結果を取得するには、 Prefer: return=representation 要求ヘッダーを使用する必要があります。

どのプロパティが返されるかを制御するには、$select クエリオプションを URL に、そしてエンティティセットに追加します。 $expand クエリオプションは、使用されている場合は無視されます。

次の使用例は、アカウントエンティティを更新し、要求されたデータを応答で返します。

要求:

PATCH [Organization URI]/api/data/v9.2/accounts(00000000-0000-0000-0000-000000000001)?$select=name,creditonhold,address1_latitude,description,revenue,accountcategorycode,createdon HTTP/1.1  
OData-MaxVersion: 4.0  
OData-Version: 4.0  
Accept: application/json  
Content-Type: application/json; charset=utf-8  
Prefer: return=representation
If-Match: * 
  
{"name":"Updated Sample Account"}

応答：

HTTP/1.1 200 OK  
Content-Type: application/json; odata.metadata=minimal  
Preference-Applied: return=representation  
OData-Version: 4.0  
  
{  
    "@odata.context": "[Organization URI]/api/data/v9.2/$metadata#accounts/$entity",  
    "@odata.etag": "W/\"536537\"",  
    "accountid": "00000000-0000-0000-0000-000000000001",  
    "accountcategorycode": 1,  
    "description": "This is the description of the sample account",  
    "address1_latitude": 47.63958,  
    "creditonhold": false,  
    "name": "Updated Sample Account",  
    "createdon": "2016-09-28T23:14:00Z",  
    "revenue": 5000000.0000,  
    "_transactioncurrencyid_value": "048dddaa-6f7f-e611-80d3-00155db5e0b6"  
}

1 つの要求で複数のレコードを更新する

1 つの要求で同じ種類の複数のレコードを更新する最も高速な方法は、 UpdateMultiple アクションを使用することです。執筆時点で、UpdateMultiple アクションが存在します。すべての標準テーブルがこのアクションをサポートしているわけではありませんが、すべてのエラスティックテーブルはサポートしています。

詳細情報:

1 つのプロパティ値を更新する

1 つのプロパティ値のみを更新する場合は、エンティティの URI にプロパティ名が追加された PUT 要求を使用します。

次の例では、name値 000000000-0000-0000-0000-0000000000001 を使用して、既存のaccount行のaccountid プロパティを更新します。

要求:

PUT [Organization URI]/api/data/v9.2/accounts(00000000-0000-0000-0000-000000000001)/name HTTP/1.1  
Content-Type: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0  
  
{"value": "Updated Sample Account Name"}

応答：

HTTP/1.1 204 No Content  
OData-Version: 4.0

1 つのプロパティ値を削除する

1 つのプロパティの値を削除するには、エンティティの URI にプロパティ名が追加された DELETE 要求を使用します。

次の例では、description値が 000000000-0000-0000-0000-0000000000001 のアカウントエンティティのaccountid プロパティの値を削除します。

要求:

DELETE [Organization URI]/api/data/v9.2/accounts(00000000-0000-0000-0000-000000000001)/description HTTP/1.1  
Content-Type: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0

応答：

HTTP/1.1 204 No Content  
OData-Version: 4.0

注

これは、2 つのエンティティの関連付けを解除するために、単一値ナビゲーションプロパティでは使用できません。別の方法については、「単一値ナビゲーションプロパティとの関連付けを解除する」を参照してください。

テーブル行の更新または追加

アップサート操作は更新に似ています。 PATCH要求を使用し、URI を使用して特定のレコードを参照します。違いは、レコードが存在しない場合は作成されるということです。既に存在する場合は更新されます。

Upsert は、外部システム間でデータを同期する場合に重要です。外部システムには Dataverse テーブルの主キーへの参照が含まれていない可能性があるため、両方のシステムでレコードを一意に識別する外部システムの値を使用して、Dataverse テーブルの代替キーを構成できます。詳細情報: 行を参照する代替キーの定義

テーブルに対して定義されている代替キーは、$metadata サービスドキュメントのエンティティ型の注釈で確認できます。詳細情報: 代替キー。

次の例では、sample_thingとsample_key1の 2 つの列を参照する代替キーを持つ名前sample_key2を持つテーブルがあります。このテーブルは、両方とも整数値を格納するために定義されています。

要求:

PATCH [Organization URI]/api/data/v9.2/sample_things(sample_key1=1,sample_key2=1) HTTP/1.1
Accept: application/json 
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Content-Type: application/json

{
    "sample_name": "1:1"
}

作成操作と更新操作の両方で、同じ応答が返されます。 OData-EntityId応答ヘッダーで、レコードの GUID 主キー識別子ではなくキー値がどのように使用されているかに注目してください。

応答：

HTTP/1.1 204 No Content
OData-Version: 4.0
OData-EntityId: [Organization URI]/api/data/v9.2/sample_things(sample_key1=1,sample_key2=1)

応答は同じであるため、操作が Create 操作と Update 操作のどちらを表したかはわかりません。

知る必要がある場合は、 Prefer: return=representation 要求ヘッダーを使用できます。このヘッダーを使用すると、レコードの作成時に 201 Created 応答が返され、レコードが更新されたときに 200 OK 応答が返されます。このオプションは、パフォーマンスに影響を与える Retrieve 操作を追加します。 Prefer: return=representation要求ヘッダーを使用する場合は、$selectに最小限のデータ量 (できれば主キー列のみ) が含まれていることを確認します。詳細情報: 返されたデータを使用して更新し、返されたデータを使用して作成します。

代替キーを使用する場合は、要求の本文に代替キーの値を含めてはいけません。

アップサートが Updateを表す場合、これらの代替キー値は無視されます。代替キー値を使用してレコードを識別している間は更新できません。
アップサートがCreateを表す場合、本文にキー値が存在しないときに、URL のキー値がレコードに設定されます。そのため、要求の本文に含める必要はありません。

詳細情報: Upsert を使用してレコードを作成または更新する

注

通常、新しいレコードを作成するときに、システムに主キーの GUID 値を割り当てることができます。これは、インデックス用に最適化されたキーがシステムによって生成され、パフォーマンスが向上するため、ベストプラクティスです。ただし、外部システムによってキー GUID 値が生成された場合など、特定の主キー値を持つレコードを作成する必要がある場合は、 upsert 操作でこれを行うことができます。

upsert を使用した作成または更新を禁止する

場合によっては、 upsertを実行したいが、潜在的な操作の 1 つ (作成または更新) を防ぐ必要がある場合があります。これは、 If-Match または If-None-Match ヘッダーを使用して行うことができます。詳細については、「アップサート操作の制限」を参照してください。

基本的な削除

削除操作は簡単です。削除するエンティティの URI で DELETE 動詞を使用します。この例のメッセージは、主キーの accountid 値が 000000000-0000-0000-0000-0000000000001 のアカウントエンティティを削除します。

要求:

DELETE [Organization URI]/api/data/v9.2/accounts(00000000-0000-0000-0000-000000000001) HTTP/1.1  
Content-Type: application/json  
OData-MaxVersion: 4.0  
OData-Version: 4.0

応答：

エンティティが存在する場合は、状態 204 で通常の応答を受け取り、削除が成功したことを示します。エンティティが見つからない場合は、状態 404 の応答が返されます。

HTTP/1.1 204 No Content  
OData-Version: 4.0

重複レコードの確認

更新操作中に重複レコードを確認する方法の詳細については、「 Web API を使用した更新操作中の重複の検出」を参照してください。

1 つの要求で複数のレコードを削除する

1 つの要求で同じ種類の複数のレコードを削除する最も高速な方法は、 DeleteMultiple アクションを使用することです。この記事の執筆時点では、 DeleteMultiple アクションはプレビュー機能です。標準テーブルではこのアクションはサポートされていませんが、すべてのエラスティックテーブルでサポートされます。

注

標準テーブルの場合は、クエリに一致するレコードの非同期削除を可能にする BulkDelete アクションを使用することをお勧めします。詳細情報: データを一括削除する

詳細情報:

ストレージパーティション内のドキュメントを更新および削除する

パーティションに格納されているエラスティックテーブルデータを更新または削除する場合は、そのデータにアクセスするときに必ずパーティションキーを指定してください。

詳細: PartitionId 値の選択

こちらも参照ください

フィードバック

このページはお役に立ちましたか?

次の方法で共有

Web API を使用してテーブル行を更新および削除する

基本的な更新

返されたデータで更新する

1 つの要求で複数のレコードを更新する

1 つのプロパティ値を更新する

1 つのプロパティ値を削除する

テーブル行の更新または追加

upsert を使用した作成または更新を禁止する

基本的な削除

重複レコードの確認

1 つの要求で複数のレコードを削除する

ストレージ パーティション内のドキュメントを更新および削除する

こちらも参照ください

フィードバック

その他のリソース

ストレージパーティション内のドキュメントを更新および削除する