Web API を使用したテーブル行の関連付けと関連付け解除
テーブル定義間に存在する関連付けを使用して、テーブル行の個々のレコードを他のレコードと関連付けることができます。 OData では、関連付けはナビゲーション プロパティとして表現されます。
どのナビゲーション プロパティが $metadata サービス ドキュメントに存在するかを検出できます。 Web API ナビゲーション プロパティを参照してください。 既存の Dataverse テーブルについては Web API EntityType Reference を、各エンティティの種類については一覧表示された単一値およびコレクション値のナビゲーション プロパティを参照してください。
次のテーブルは、Dataverse のテーブル間の関連付けの 3 つのタイプについて説明しています。
| タイプ | 説明設定 | 例 |
|---|---|---|
| 一対多 | 1 つのレコードに多数のレコードを関連付けることができます。 | account レコードは contact_customer_accountsコレクション値ナビゲーション プロパティに多数の contact レコードを持つことができます。 |
| 多対一 | 多数のレコードを 1 つのレコードに関連付けることができます。 多対一は、一対多の関連付けのミラー イメージです。 関連付けは 1 つだけです。 |
複数の contact レコードは parentcustomerid_account 単一値ナビゲーション プロパティを使用してaccount レコードに関連付けられます。 |
| 多対多 | 多数のレコードを多数のレコードに関連付けることができます。 | 各 security role (role) には、systemuser の定義への参照を含まれる場合があります。 これらのテーブルには共に systemuserroles_association コレクション値ナビゲーション プロパティがあります。 |
単一値ナビゲーション プロパティを使用する
一対多または多対一の関連付けの多側の既存のレコードについては、他のレコードへの URI 参照を設定することでレコードを関連付けることができます。 これを行う一番簡単で一般的な方法は、単一値ナビゲーション プロパティの名前に @odata.bind 注釈を追加してから、その値を PATCH 要求で他のレコードに URI として設定する方法です。
単一値ナビゲーション プロパティと関連付ける
たとえば、parentcustomerid_account 単一値ナビゲーション プロパティを使用して contact レコードを account に関連付けます:
要求:
PATCH [Organization Uri]/api/data/v9.2/contacts(cf9eaaef-f718-ed11-b83e-00224837179f) 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(cf9eaaef-f718-ed11-b83e-00224837179f)
作成時にテーブル行を関連付けるで説明されているように、新しいレコードも同じ方法で既存のレコードに関連付けることができます。
単一値ナビゲーション プロパティとの関連付けを解除する
関連付けを解除する場合は、単に値を null に設定できます。
要求:
PATCH [Organization Uri]/api/data/v9.2/contacts(cf9eaaef-f718-ed11-b83e-00224837179f) 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(cf9eaaef-f718-ed11-b83e-00224837179f)
この方法で関連付けを解除する場合、@odata.bind 注釈を含める必要はありません。 単一値ナビゲーション プロパティの名前を使用するだけです:
要求:
PATCH [Organization Uri]/api/data/v9.2/contacts(cf9eaaef-f718-ed11-b83e-00224837179f) 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(cf9eaaef-f718-ed11-b83e-00224837179f)
詳細情報: 基本アップデート
他のメソッド
単一値ナビゲーション プロパティを使用して、上記と同じ結果を得る方法は他にもあります。
以下の PUT を使用して、parentcustomerid_account 単一値ナビゲーション プロパティの値を設定できます:
要求:
PUT [Organization Uri]/api/data/v9.2/contacts(cf9eaaef-f718-ed11-b83e-00224837179f)/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
注意
注: @odata.id の値を設定時には、絶対 URL を使用する必要があります。
参照を削除するには、この DELETE 要求も使用できます:
要求:
DELETE [Organization Uri]/api/data/v9.2/contacts(cf9eaaef-f718-ed11-b83e-00224837179f)/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 では、多対多の関連付けの両側にコレクション値ナビゲーション プロパティがあります。 一対多および多対一の関連付の場合、「一」側のテーブルにコレクション値ナビゲーション プロパティがあることになります。 コレクション値ナビゲーション プロパティを使用する際に、これらのタイプの関連付けをどう操作するかに違いはありません。 このセクションでは、任意のタイプの関連付けを使用してコレクション値ナビゲーション プロパティを操作する方法について説明します。
レコードをコレクションに追加する
次の例は、contact レコードを一対多の関連付けの一部である accountcontact_customer_accounts コレクションに追加する方法を示します。
要求:
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(cf9eaaef-f718-ed11-b83e-00224837179f)"
}
応答:
HTTP/1.1 204 NoContent
OData-Version: 4.0
次の例は、role レコードを多対多の関連付けの一部である 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
レコードをコレクションから削除する
次の例は、contact レコードを、取引先担当者 contactid 値が cf9eaaef-f718-ed11-b83e-00224837179f である accountcontact_customer_accounts コレクションから削除する方法を示します。
要求:
DELETE [Organization Uri]/api/data/v9.2/accounts(ce9eaaef-f718-ed11-b83e-00224837179f)/contact_customer_accounts(cf9eaaef-f718-ed11-b83e-00224837179f)/$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(cf9eaaef-f718-ed11-b83e-00224837179f) 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 を使用する条件付き演算を実行する
注意
ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)
この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示