Web API を使用したテーブル行の関連付けと関連付け解除

テーブル定義間に存在する関連付けを使用して、テーブル行の個々のレコードを他のレコードと関連付けることができます。 OData では、関連付けはナビゲーション プロパティとして表現されます。

どのナビゲーション プロパティが $metadata サービス ドキュメントに存在するかを検出できます。 Web API ナビゲーション プロパティを参照してください。 既存の Dataverse テーブルについては、 Web API EntityType リファレンスを参照してください。各エンティティの種類については、一覧表示されている単一値およびコレクション値のナビゲーション プロパティを参照してください。

次のテーブルは、Dataverse のテーブル間の関連付けの 3 つのタイプについて説明しています。

単一値ナビゲーション プロパティを使用する

一対多または多対一の関連付けの多側の既存のレコードについては、他のレコードへの URI 参照を設定することでレコードを関連付けることができます。 これを行う最も簡単で最も一般的な方法は、@odata.bind 注釈を 単一値ナビゲーション プロパティに追加し、PATCH 要求の他のレコードに Uri として値を設定することです。

単一値ナビゲーション プロパティと関連付ける

例えば、parentcustomerid_account単一値ナビゲーション プロパティを使用して取引先担当者レコードを取引先企業に関連付けるには:

要求:

PATCH [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee) HTTP/1.1
If-Match: *
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "parentcustomerid_account@odata.bind": "accounts(ce9eaaef-f718-ed11-b83e-00224837179f)"
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0
OData-EntityId: [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)

作成時にテーブル行を関連付けるで説明されているように、新しいレコードも同じ方法で既存のレコードに関連付けることができます。

単一値ナビゲーション プロパティとの関連付けを解除する

関連付けを解除する場合は、単に値を null に設定できます。

要求:

PATCH [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee) HTTP/1.1
If-Match: *
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "parentcustomerid_account@odata.bind": null
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0
OData-EntityId: [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)

この方法で関連付けを解除する場合、@odata.bind 注釈を含める必要はありません。 単一値ナビゲーション プロパティの名前を使用するだけです:

要求:

PATCH [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee) HTTP/1.1
If-Match: *
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "parentcustomerid_account": null
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0
OData-EntityId: [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)

詳細情報: 基本アップデート

他のメソッド

単一値ナビゲーション プロパティで前に説明したのと同じ結果を得るには、他の方法もあります。

以下の PUT を使用して、parentcustomerid_account 単一値ナビゲーション プロパティの値を設定できます:

要求:

PUT [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)/parentcustomerid_account/$ref HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "@odata.id": "[Organization URI]/api/data/v9.2/accounts(ce9eaaef-f718-ed11-b83e-00224837179f)"
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

参照を削除するには、この DELETE 要求も使用できます:

要求:

DELETE [Organization Uri]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)/parentcustomerid_account/$ref HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

コレクション値ナビゲーション プロパティを使用する

OData では、多対多リレーションシップの両側にコレクション値のナビゲーション プロパティがあります。 一対多および多対一のリレーションシップの場合、'One' 側のテーブルにはコレクション値のナビゲーション プロパティがあります。 コレクション値ナビゲーション プロパティを使用する場合のこれらの種類のリレーションシップの操作方法に違いはありません。 このセクションでは、任意の種類のリレーションシップを持つコレクション値ナビゲーション プロパティを操作する方法について説明します。

レコードをコレクションに追加する

次の例は、取引先担当者レコードを取引先企業contact_customer_accountsコレクション (1 対多リレーションシップ) に追加する方法を示しています。

要求:

POST [Organization Uri]/api/data/v9.2/accounts(ce9eaaef-f718-ed11-b83e-00224837179f)/contact_customer_accounts/$ref HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "@odata.id": "[Organization URI]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)"
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

次の例は、 ロール レコードを systemusersystemuserroles_association コレクション (多対多リレーションシップ) に追加する方法を示しています。

要求:

POST [Organization Uri]/api/data/v9.2/systemusers(34dcbaf5-f718-ed11-b83e-00224837179f)/systemuserroles_association/$ref HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

{
  "@odata.id": "[Organization URI]/api/data/v9.2/roles(886b280c-6396-4d56-a0a3-2c1b0a50ceb0)"
}

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

レコードをコレクションから削除する

次の例は、取引先担当者contactid値が 00aa00aa-bb11-cc22-dd33-44ee44ee44ee の取引先担当者contact_customer_accountsコレクションに取引先担当者レコードを削除する方法を示しています。

要求:

DELETE [Organization Uri]/api/data/v9.2/accounts(ce9eaaef-f718-ed11-b83e-00224837179f)/contact_customer_accounts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee)/$ref HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

次の要求も機能します。

要求:

DELETE [Organization Uri]/api/data/v9.2/accounts(ce9eaaef-f718-ed11-b83e-00224837179f)/contact_customer_accounts/$ref?$id=[Organization URI]/api/data/v9.2/contacts(00aa00aa-bb11-cc22-dd33-44ee44ee44ee) HTTP/1.1
OData-MaxVersion: 4.0
OData-Version: 4.0
If-None-Match: null
Accept: application/json

応答:

HTTP/1.1 204 NoContent
OData-Version: 4.0

参照

Web API 基本操作のサンプル (C#)
Web API 基本操作のサンプル (クライアント側の JavaScript)
Web API を使用して演算を実行する
HTTP 要求の作成とエラーの処理
Web API を使用したクエリ データ
Web API を使用してテーブル行を作成する
Web API を使用してテーブルの行を取得する
Web API を使用したテーブル行の更新と削除
Web API 関数の使用
Web API アクションの使用
Web API を使用してバッチ操作を実行する
Web API を使用して別のユーザーを偽装する
Web API を使用する条件付き演算を実行する