Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Dans le document CSDL $metadata, vous trouverez Action des éléments qui décrivent les opérations qui modifient les données.
Chaque action a un Name attribut. Ce nom fait partie de l’URL lorsque vous utilisez HTTPPOST, en envoyant tous les paramètres définis pour l’action dans le corps de la requête. Pour plus d’informations : Utiliser les actions de l’API web
Actions liées
Les actions peuvent avoir un IsBound="true" attribut. Cela signifie qu’il s’agit d’une action liée . Les actions sans l’attribut IsBound ne sont pas liées. Une action liée signifie que le premier paramètre est une référence à un enregistrement de table ou à un jeu d’entités.
Lorsqu’une action est liée, elle aura une référence à un élément spécifique dans l’espace de noms de service. Pour utiliser l’action, vous devez utiliser le nom qualifié complet, y compris l’espace de noms Microsoft.Dynamics.CRM. Plus d’informations : Espace de noms de service
Paramètres
Les actions ont généralement un ou plusieurs Parameter éléments. Chaque paramètre a les attributs suivants :
| Caractéristique | Descriptif |
|---|---|
Name |
Nom du paramètre. Le nom est unique, sauf si Action est surchargé. Plus d’informations : Actions surchargées. |
Type |
Type de paramètre. |
Nullable="false" |
Indique si le paramètre peut accepter une valeur Null. |
ReturnType
Les actions peuvent retourner des valeurs. Lorsqu’une action retourne une valeur, elle aura un ReturnType élément.
| Caractéristique | Descriptif |
|---|---|
Type |
Type de paramètre. |
Nullable="false" |
Indique si la valeur peut être null. |
Exemples de définition d’action
Voici quelques exemples fictifs de définitions montrant différents modèles de Action liaison. Chacun de ces exemples retourne une valeur entière.
Actions non liées
Action indépendante avec un seul paramètre entier Number .
<Action Name="UnBoundActionExample">
<Parameter Name="Number" Type="Edm.Int32" Nullable="false" />
<ReturnType Type="Edm.Int32" Nullable="false" />
</Action>
Action liée à une entité
Action liée à l’entité account avec un paramètre entier Number unique.
<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>
Action liée à un jeu d’entités
Action liée à account EntitySet avec un paramètre entier Number unique.
<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>
Actions surchargées
En règle générale, chaque action que vous trouvez dans le $metadata sera la seule action portant ce nom. Toutefois, les actions liées peuvent avoir plusieurs définitions lorsqu’elles sont liées à différents types. L’action AddItemCampaign incluse dans la solution marketing est un exemple. Vous ne pouvez pas créer une action surchargée à l’aide de l’API personnalisée.
Plus d’informations : Règles de surcharge d’action
Étapes suivantes
En savoir plus sur les définitions de fonction.
Voir aussi
Types d’API Web et opérations
Documents de service d’API web
EntityTypes de l’API web
Propriétés de l’API web
Propriétés de navigation de l’API web
Fonctions d’API web
Types complexes et énumération de l’API web
Utiliser l’API web Dataverse
Spécification d’action OData 4.0