Web API を使用したテーブルの関連性の作成および更新

[アーティクル]
12/15/2022

Web APIは、関連性定義 (メタデータ) の操作をサポートします。テーブルの関連性の定義で説明されている概念は、Web API にも適用されます。

Action	内容
CanBeReferenced Action	指定されたエンティティが一対多の関連性の主エンティティ (一) になるかどうかをチェックします。
CanBeReferencing Action	指定されたエンティティが一対多の関連性の参照エンティティ (多) になるかどうかをチェックします。
CanManyToMany Action	エンティティが多対多の関連性に参加できるかどうかをチェックします。
GetValidManyToMany Function	多対多の関連性に参加できる一連のエンティティを返します。
GetValidReferencedEntities Function	指定されたエンティティから、1 対多の関連性の主エンティティ (1 の側) として有効な一連のエンティティを返します。
GetValidReferencingEntities Function	指定されたエンティティに、1 対多の関連性の関連エンティティ (多の側) として有効な一連のエンティティを返します。

一対多の関連性を作成する

一対多の関連性を作成する場合は、OneToManyRelationshipMetadata EntityType を使用して定義します。この定義には、LookupAttributeMetadata EntityType を使用して定義される検索属性が含まれ、AssociatedMenuConfiguration ComplexType CascadeConfiguration ComplexType Label ComplexType および LocalizedLabel ComplexType を使用した複雑なプロパティも必要です。検索属性は OneToManyRelationshipMetadata オブジェクトの検索の単一値のナビゲーションプロパティに設定され、ディープ挿入 を使用して同時に作成されます。詳細: 1 回の操作で関連するテーブル行を作成するとテーブルの関係性のメタデータ

一対多の関連性にカスタムナビゲーションプロパティ名を使用する場合は、 ReferencingEntityNavigationPropertyName および ReferencedEntityNavigationPropertyName プロパティの値を設定きます。

関係性とルックアップ属性の定義に必要な JSON を生成後は、その JSON を RelationshipDefinitions のエンティティセットに POST します。この同じエンティティセットを使って多対多の関連付けを作成できるため、作成している関連付けの種類を明確にするために @odata.type プロパティの値を Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata に含める必要があります。作成された関連性の URI が応答で返されます。

要求:

POST [Organization URI]/api/data/v9.2/RelationshipDefinitions HTTP/1.1  
Accept: application/json  
Content-Type: application/json; charset=utf-8  
OData-MaxVersion: 4.0  
OData-Version: 4.0  
  
{  
 "SchemaName": "new_contact_new_bankaccount",  
 "@odata.type": "Microsoft.Dynamics.CRM.OneToManyRelationshipMetadata",  
 "AssociatedMenuConfiguration": {  
  "Behavior": "UseCollectionName",  
  "Group": "Details",  
  "Label": {  
   "@odata.type": "Microsoft.Dynamics.CRM.Label",  
   "LocalizedLabels": [  
    {  
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
     "Label": "Bank Accounts",  
     "LanguageCode": 1033  
    }  
   ],  
   "UserLocalizedLabel": {  
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
    "Label": "Bank Accounts",  
    "LanguageCode": 1033  
   }  
  },  
  "Order": 10000  
 },  
 "CascadeConfiguration": {  
  "Assign": "Cascade",  
  "Delete": "Cascade",  
  "Merge": "Cascade",  
  "Reparent": "Cascade",  
  "Share": "Cascade",  
  "Unshare": "Cascade"  
 },  
 "ReferencedAttribute": "contactid",  
 "ReferencedEntity": "contact",  
 "ReferencingEntity": "new_bankaccount",  
 "Lookup": {  
  "AttributeType": "Lookup",  
  "AttributeTypeName": {  
   "Value": "LookupType"  
  },  
  "Description": {  
   "@odata.type": "Microsoft.Dynamics.CRM.Label",  
   "LocalizedLabels": [  
    {  
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
     "Label": "The owner of the account",  
     "LanguageCode": 1033  
    }  
   ],  
   "UserLocalizedLabel": {  
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
    "Label": "The owner of the account",  
    "LanguageCode": 1033  
   }  
  },  
  "DisplayName": {  
   "@odata.type": "Microsoft.Dynamics.CRM.Label",  
   "LocalizedLabels": [  
    {  
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
     "Label": "Account Owner",  
     "LanguageCode": 1033  
    }  
   ],  
   "UserLocalizedLabel": {  
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
    "Label": "Account Owner",  
    "LanguageCode": 1033  
   }  
  },  
  "RequiredLevel": {  
   "Value": "ApplicationRequired",  
   "CanBeChanged": true,  
   "ManagedPropertyLogicalName": "canmodifyrequirementlevelsettings"  
  },  
  "SchemaName": "new_AccountOwner",  
  "@odata.type": "Microsoft.Dynamics.CRM.LookupAttributeMetadata"  
 }  
}

応答:

HTTP/1.1 204 No Content  
OData-Version: 4.0  
OData-EntityId: [Organization URI]/api/data/v9.2/RelationshipDefinitions(d475020f-5d7c-e511-80d2-00155d2a68d2)

多対多の関連性を作成する

多対多の関連性にカスタムナビゲーションプロパティ名を使用する場合は、 Entity1NavigationPropertyName および Entity2NavigationPropertyName プロパティの値を設定きます。

関係性を定義するために必要な JSON の生成後は、その JSON を RelationshipDefinitions のエンティティセットに POST します。この同じエンティティセットを使って一対多の関連付けを作成できるため、作成している関連付けの種類を明確にするために @odata.type プロパティの値を Microsoft.Dynamics.CRM.ManyToManyRelationshipMetadata に含める必要があります。結果として、関係性の URI の応答が返されます。

要求:

POST [Organization URI]/api/data/v9.2/RelationshipDefinitions HTTP/1.1  
Accept: application/json  
Content-Type: application/json; charset=utf-8  
OData-MaxVersion: 4.0  
OData-Version: 4.0  
  
{  
 "SchemaName": "new_accounts_campaigns",  
 "@odata.type": "Microsoft.Dynamics.CRM.ManyToManyRelationshipMetadata",  
 "Entity1AssociatedMenuConfiguration": {  
  "Behavior": "UseLabel",  
  "Group": "Details",  
  "Label": {  
   "@odata.type": "Microsoft.Dynamics.CRM.Label",  
   "LocalizedLabels": [  
    {  
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
     "Label": "Account",  
     "LanguageCode": 1033  
    }  
   ],  
   "UserLocalizedLabel": {  
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
    "Label": "Account",  
    "LanguageCode": 1033  
   }  
  },  
  "Order": 10000  
 },  
 "Entity1LogicalName": "account",  
 "Entity2AssociatedMenuConfiguration": {  
  "Behavior": "UseLabel",  
  "Group": "Details",  
  "Label": {  
   "@odata.type": "Microsoft.Dynamics.CRM.Label",  
   "LocalizedLabels": [  
    {  
     "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
     "Label": "Campaign",  
     "LanguageCode": 1033  
    }  
   ],  
   "UserLocalizedLabel": {  
    "@odata.type": "Microsoft.Dynamics.CRM.LocalizedLabel",  
    "Label": "Campaign",  
    "LanguageCode": 1033  
   }  
  },  
  "Order": 10000  
 },  
 "Entity2LogicalName": "campaign",  
 "IntersectEntityName": "new_accounts_campaigns"  
}

応答:

HTTP/1.1 204 No Content  
OData-Version: 4.0  
OData-EntityId: [Organization URI]/api/data/v9.2/RelationshipDefinitions(420245fa-c77c-e511-80d2-00155d2a68d2)

リレーションシップを作成して、マルチテーブル検索をサポートする

マルチテーブル検索タイプの列を使用すると、ユーザーは、環境内の他のテーブルに対して複数の一対多 (1:M) の関連付けを持つ特定のテーブルを使用できます。単一の検索タイプの列は、他の複数のテーブルを参照できます。マルチテーブルタイプの列に送信された検索値は、関連するテーブルのいずれかのレコードと一致します。

詳細: マルチテーブル検索列を使用する

関係性の更新

テーブル定義の更新で説明したように、HTTP PUT メソッドを使って関係性を更新し、既存の定義を適用したい変更点で置き換えることができます。ビジネスデータテーブルのように、HTTP PATCH メソッドを使用して個々のプロパティを編集することはできません。エンティティや属性の場合と同じように、 true に設定された値の MSCRM.MergeLabels 見出しを使用して、更新に含まれていないローカライズ済みのラベルの上書きを防止し、システムでアクティブ化される前にカスタマイズを公開する必要があります。

次の方法で共有

Web API を使用したテーブルの関連性の作成および更新

関連性の有効性

一対多の関連性を作成する

多対多の関連性を作成する

リレーションシップを作成して、マルチテーブル検索をサポートする

関係性の更新

関連性の削除

関連項目

その他のリソース