Xrm.WebApi.online.executeMultiple (référence de l’API client)

  • Article

Effectuer un ensemble d’actions, de fonctions ou d’opérations CRUD.

Notes

Cette méthode est prise en charge uniquement pour le mode connexion (Xrm.WebApi.online).

Si vous souhaitez exécuter plusieurs demandes dans une transaction, vous devez transmettre un ensembles de modifications comme paramètre à cette méthode. Les ensembles de modifications représentent une collection d’opérations exécutées dans une transaction. Vous pouvez également transmettre des demandes individuelles et des ensembles de modifications comme paramètres à cette méthode.

Notes

  • Vous ne pouvez pas inclure des opérations de lecture (récupération, récupération multiple et fonctions de l’API Web) dans le cadre d’un ensemble de modifications conformément aux spécifications OData v4.
  • Les demandes peuvent contenir jusqu’à 1 000 demandes individuelles et ne peuvent pas contenir d’autres lots. Pour plus d’informations : Exécuter des opérations par lots à l’aide de l’API Web.

Syntaxe

Exécuter plusieurs demandes :

var requests = [req1, req2, req3];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Exécuter plusieurs demandes dans une transaction :

Dans ce cas, req1, req2 et req3 sont exécutés dans une transaction.

var changeSet = [req1, req2, req3];
var requests = [changeSet];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Exécuter une combinaison de demandes individuelles et de demandes multiples dans une transaction :

Dans ce cas, req1, req2 et req3 sont exécutés dans la transaction, mais req4 et req5 sont exécutés individuellement.

var changeSet = [req1, req2, req3];
var requests = [req4, req5, changeset];
Xrm.WebApi.online.executeMultiple(requests).then(successCallback, errorCallback);

Paramètres

Nom  Type Requise Description
requests Tableau d’objets Oui Tableau de l’un des types suivants :

Objets où chaque objet est une action, une fonction ou une demande CRUD que vous souhaitez exécuter sur le point de terminaison de l’API Web. Chaque objet expose une méthode getMetadata qui vous permet de définir les métadonnées de l’action, de la fonction ou de la demande CRUD à exécuter. La méthode d’exécution accepte ce type de paramètre.

Ensemble de modifications (tableau d’objets), où chaque objet de l’ensemble de modifications est tel que défini ci-dessus. Dans ce cas, tous les objets de demande spécifiés dans l’ensemble de modifications sont exécutés dans une transaction.

Consultez les exemples de demande décrits dans la section Syntaxe pour plus d’informations.
successCallback Function Non Fonction à appeler lorsque l’opération est effectuée avec succès. Un tableau d’objets de réponse est transmis à la fonction. Voir Valeur renvoyée
errorCallback Function Non Fonction à appeler lorsque l’opération échoue.

Valeur renvoyée

En cas de succès, retourne un objet promesse contenant un tableau d’objets à successCallback. Les objets ont ces propriétés :

Nom Type Requise Description
json Promettre Non Corps de réponse au format JSON.
text Promettre Non Corps de réponse au format PlainText.
headers Object Oui En-têtes de réponse.
ok Valeur booléenne Oui Indique si la demande a réussi.
status Chiffre Oui Valeur numérique dans le code de statut de la réponse. Par exemple : 200
statusText String Oui Description du code d’état de la réponse. Par exemple : OK
type String Oui Type de réponse. Les valeurs sont : chaîne vide (par défaut), arraybuffer, blob, document, json et text.
url String Oui URL de demande de l’action, de la fonction ou de la demande CRUD qui a été envoyée au point de terminaison de l’API Web.

Xrm.webApi

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é).