Web API-Aktionen

Artikel
04/09/2023

Innerhalb des CSDL-$metadata-Dokuments befinden sich Action-Elemente, die Vorgänge beschreiben, die Daten ändern.

Jede Aktion enthält ein Name-Attribut. Dieser Name wird Teil der URL sein, wenn Sie HTTP``POST verwenden, wobei alle definierten Parameter für die Aktion im Text der Anfrage gesendet werden. Weitere Informationen finden Sie unter Verwenden von Web-API-Aktionen.

Gebundene Aktionen

Aktionen können ein IsBound="true"-Attribut enthalten. Dies bedeutet, dass es sich um eine gebundene Aktion. Aktionen ohne das Attribut IsBound sind ungebunden. Eine gebundene Aktion bedeutet, dass der erste Parameter ein Verweis auf einen Tabellendatensatz oder auf ein Entitätsset ist.

Wenn eine Aktion gebunden ist, enthält sie einen Verweis auf ein bestimmtes Element im Service-Namespace. Um die Aktion zu verwenden, geben Sie den vollqualifizierten Namen mit dem Namespace Microsoft.Dynamics.CRM ein. Weitere Informationen: Service-Namespace

Parameter

Aktionen haben normalerweise ein oder mehrere Parameter-Elemente. Jeder Parameter hat die folgenden Attribute:

Attribut	Beschreibung
`Name`	Der Name des Parameters. Der Name ist eindeutig, es sei denn, die `Action` ist überlastet. Weitere Informationen finden Sie unter Überlastete Aktionen.
`Type`	Der Typ von Parameter.
`Nullable="false"`	Ob der Parameter einen Nullwert akzeptieren kann.

ReturnType

Aktionen können Werte zurückgeben. Wenn eine Aktion einen Wert zurückgibt, enthält sie ein ReturnType-Element.

Attribut	Beschreibung
`Type`	Der Typ von Parameter.
`Nullable="false"`	Ob der Wert null sein darf.

Beispiele für Aktionsdefinitionen

Es folgen einige fiktive Beispiele der Action-Definitionen, die unterschiedliche Bindungsmuster zeigen. Jedes dieser Beispiele gibt einen ganzzahligen Wert zurück.

Ungebundene Aktionen

Eine ungebundene Aktion mit einer einzelnen ganzzahligen Number-Parameter.

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

An eine Entität gebundene Aktion

Eine an die account-Entität gebundene Aktion mit einem einzelnen ganzzahligen Number-Parameter.

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

An ein Entitätsset gebundene Aktion

Eine an das account-Entitätsset gebundene Aktion mit einem einzelnen ganzzahligen Number-Parameter.

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

Überladene Aktionen

Normalerweise ist jede in $metadaten gefundene Aktion die einzige Aktion mit diesem Namen. Gebundene Aktionen können jedoch mehrere Definitionen haben, wenn sie an verschiedene Typen gebunden sind. Die Aktion AddItemCampaign in der Marketinglösung ist ein Beispiel. Sie können keine überladene Aktion mit angepasster API erstellen.

Weitere Informationen finden Sie unter Regeln für überladene Aktionen.

Nächste Schritte,

Informationen zu Funktionsdefinitionen.

Funktionsdefinitionen

Siehe auch

Internet API-Typen und -Vorgänge
Web API-Servicedokumente
Web API Entitätstypen
Web API-Eigenschaften
Navigationseigenschaften der Web API
Web API-Funktionen
Komplexe Typen und Enumerationstypen (Web API)
Dataverse-Web API verwenden
OData 4.0 Aktionsspezifikation

Hinweis

Können Sie uns Ihre Präferenzen für die Dokumentationssprache mitteilen? Nehmen Sie an einer kurzen Umfrage teil. (Beachten Sie, dass diese Umfrage auf Englisch ist.)

Die Umfrage dauert etwa sieben Minuten. Es werden keine personenbezogenen Daten erhoben. (Datenschutzbestimmungen).

Freigeben über