Actions de l’API web

  • Article

Au sein du document de $métadonnées CSDL, vous trouverez des éléments Action qui décrivent les opérations qui modifient les données.

Chaque action a un attribut Name. Ce nom fera partie de l’URL lorsque vous utiliserez HTTP``POST, 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 attribut IsBound="true". Cela signifie qu’il s’agit d’une action liée. Les actions sans attribut IsBound sont non 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 éléments Parameter. Chaque paramètre aura les attributs suivants :

Attribut Description
Name Nom du paramètre.
Le nom est unique à moins que l’Action soit surchargée. Pour plus d’informations : Actions surchargées.
Type Type de paramètre.
Nullable="false" Indique si le paramètre peut accepter une valeur nulle.

ReturnType

Les actions peuvent renvoyer des valeurs. Lorsqu’une action renvoie une valeur, elle aura un élément ReturnType.

Attribut Description
Type Type de paramètre.
Nullable="false" Indique si la valeur peut être nulle.

Exemples de définition de l’action

Voici quelques exemples fictifs de définitions d’Action montrant différents modèles de liaison. Chacun de ces exemples renvoie une valeur entière.

Actions non liées

Une action non liée avec un seul paramètre Number entier.

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

Action liée à une entité

Une action liée à l’entité account avec un seul paramètre Number d’entier.

<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

Une action liée à l’EntitySet account avec un seul paramètre Number d’entier.

<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

Habituellement, chaque action que vous trouverez dans les $métadonnées sera la seule action portant ce nom. Cependant, 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 d’action surchargée en utilisant API personnalisée.

Pour plus d’informations : Règles de surcharge d’action

Étapes suivantes

Découvrez les définitions de fonction.

Définitions de fonction

Voir aussi

Types d’API web et opérations
Documents de service de l’API web
EntityTypes de l’API web
Propriétés de l’API web
Propriétés de navigation de l’API web
Fonctions de l’API web
Types Complex et Enumeration de l’API web
Utilisation de l’API web Dataverse
Spécification des actions OData 4.0

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).