Web API アクション

CSDL $metadata ドキュメント 内には、データを変更する操作について説明している Action 要素があります。

すべてのアクションには Name 属性があります。 この名前は、HTTP POST を使用するときの URL の一部になり、要求の本文でアクションの定義されたパラメータを送信します。 詳細: Web API アクションの使用

バインドされたアクション

アクションには、IsBound="true" 属性が含まれる場合があります。 つまり、バインドされた アクションです。 IsBound 属性のないアクションは バインドされていません。 バインドされたアクションは、最初のパラメーターがテーブル レコードまたはエンティティ セットへの参照であることを意味します。

アクションがバインドされると、サービス名前空間内の特定のアイテムへの参照が含まれます。 アクションを使用するには、Microsoft.Dynamics.CRM 名前空間を含む完全修飾名を使用する必要があります。 詳細: サービス名前空間

パラメーター

通常、アクションには: 1 つ以上の Parameter 要素があります。 各パラメーターには、次の属性があります。

属性	説明
Name	パラメーターの名前。 名前は、Action がオーバーロードしていない限り一意です。 詳細: オーバーロードしたアクション を参照してください。
Type	パラメーターの種類。
Nullable="false"	パラメータが null 値を受け入れることができるかどうか。

ReturnType

アクションは値を返す場合があります。 アクションが値を返す場合、アクションには ReturnType 要素があります。

属性	説明
Type	パラメーターの種類。
Nullable="false"	値が null 値である可能性があるかどうか。

アクション定義の例

以下は、異なるバインド パターンを表示している Action 定義の架空の例です。 これらの各例は整数値を返します。

バインドされていないアクション

単一の整数 Number パラメーターを持つバインドされていないアクション。

<Action Name="UnBoundActionExample">
    <Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
    <ReturnType Type="Edm.Int32" Nullable="false" />
</Action>

エンティティにバインドされたアクション

単一の整数 Number パラメーターを持つ account エンティティにバインドされたアクション。

<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>

エンティティ セットにバインドされたアクション

単一の整数 Number パラメーターを持つ account 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 アクションは一例です。 カスタム API を使用しているオーバーロードされたアクションを作成することはできません。

詳細: オーバーロードしたアクションのルール

次の手順

関数の定義について説明します。

関数の定義

参照

Web API の種類および操作
Web API サービス ドキュメント
Web API EntityTypes
Web API プロパティ
Web API ナビゲーション プロパティ
Web API 関数
Web API の複合型および列挙の種類
Dataverse Web API を使用する
OData 4.0 アクションの仕様

注意

ドキュメントの言語設定についてお聞かせください。 簡単な調査を行います。 (この調査は英語です)

この調査には約 7 分かかります。 個人データは収集されません (プライバシー ステートメント)。