CSDL $metadata ドキュメント内には、データを変更する操作を記述するAction要素があります。
すべてのアクションには Name 属性があります。 この名前は、 HTTPPOSTを使用し、要求の本文でアクションの定義済みパラメーターを送信するときに URL の一部になります。 詳細: Web API アクションの使用
バインドされたアクション
アクションには IsBound="true" 属性が含まれる場合があります。 これは、 バインドされた アクションであることを意味します。
IsBound属性のないアクションはバインド解除されます。 バインドされたアクションは、最初のパラメーターがテーブル レコードまたはエンティティ セットへの参照であることを意味します。
アクションがバインドされると、サービス名前空間内の特定の項目への参照が含まれます。 アクションを使用するには、 Microsoft.Dynamics.CRM 名前空間を含む完全修飾名を使用する必要があります。 詳細情報: サービス名前空間
パラメーター
通常、アクションには 1 つ以上の Parameter 要素があります。 各パラメーターには、次の属性があります。
| 特性 | Description |
|---|---|
Name |
パラメーターの名前です。Actionがオーバーロードされていない限り、名前は一意です。 詳細: オーバーロードされたアクション。 |
Type |
パラメーターの型。 |
Nullable="false" |
パラメーターが null 値を受け取ることができるかどうか。 |
ReturnType
アクションは値を返す場合があります。 アクションが値を返すと、 ReturnType 要素が含まれます。
| 特性 | Description |
|---|---|
Type |
パラメーターの型。 |
Nullable="false" |
値が null であるかどうかを示します。 |
アクション定義の例
次に、さまざまなバインド パターンを示す Action 定義の架空の例をいくつか示します。 これらの各例では、整数値が返されます。
バインドなしアクション
単一の整数 Number パラメーターを持つバインドされていないアクション。
<Action Name="UnBoundActionExample">
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
エンティティにバインドされたアクション
1 つの整数account パラメーターを使用して、Number エンティティにバインドされたアクション。
<Action Name="EntityBoundActionExample" IsBound="true">
<Parameter Name="entity" Type="mscrm.account" Nullable="false" />
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
エンティティ セットに関連付けられたアクション
単一の整数account パラメーターを使用して、Number EntitySet にバインドされたアクション。
<Action Name="EntityCollectionBoundActionExample" IsBound="true">
<Parameter Name="entityset" Type="Collection(mscrm.account)" Nullable="false" />
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
オーバーロードされたアクション
通常、$metadataで見つかる各アクションは、その名前の唯一のアクションになります。 ただし、バインドされたアクションは、異なる型にバインドされている場合に複数の定義を持つことができます。 マーケティング ソリューションを含む AddItemCampaign アクションが 1 つの例です。
カスタム API を使用してオーバーロードされたアクションを作成することはできません。
詳細情報: アクション オーバーロード ルール
次のステップ
関数定義について説明します。
こちらも参照ください
Web API の種類と操作
Web API サービス ドキュメント
Web API EntityTypes
Web API のプロパティ
Web API のナビゲーション プロパティ
Web API 関数
Web API の複合型と列挙型
Dataverse Web API を使用する
OData 4.0 アクションの仕様