Partager via

retrieveRecord (référence de l’API client)

  • Article

Récupère un enregistrement de table.

Syntaxe

Xrm.WebApi.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Paramètres

Nom Type Requise Description
entityLogicalName String Oui Nom logique de la table de l’enregistrement à récupérer. Par exemple : account.
id String Oui GUID de l’enregistrement de table à extraire.
options String Non Options de requête du système OData pour contrôler ce qui est renvoyé. Voir options
successCallback Function Non Fonction à appeler lorsqu’un enregistrement est récupéré. Un objet JSON avec les propriétés récupérées et les valeurs est transmis pour identifier la fonction.
errorCallback Function Non Fonction à appeler lorsque l’opération échoue.

Options

Pour contrôler ce qui est renvoyé, utilisez les options de requête du système OData, $select et $expand, pour récupérer vos données.

Utilisez l’option de requête système $select pour limiter les propriétés retournées en incluant une liste de noms de propriété séparés par des virgules. La sélection de propriétés spécifiques est une bonne pratique importante en matière de performances. Si des propriétés ne sont pas spécifiées à l’aide de $select, toutes les propriétés sont renvoyées.

Utilisez l’option de requête système $expand pour contrôler quelles données des tables associées sont renvoyées. Si vous incluez uniquement le nom de la propriété de navigation, vous recevrez toutes les propriétés des enregistrements associés. Vous pouvez limiter les propriétés retournées pour les enregistrements associés à l’aide de l’option de requête système $select entre parenthèses après le nom de propriété de navigation. Utilisez cette procédure pour les propriétés de navigation à valeur unique et avec valeur de collection. Pour le mode hors connexion, nous ne prenons en charge que l’option imbriquée $select à l’intérieur de l’option $expand.

Vous spécifiez les options de requête à partir de ?. Vous pouvez également spécifier plusieurs options de requête système en utilisant & pour séparer les options de requête. Par exemple :

?$select=name&$expand=primarycontactid($select=contactid,fullname)

Consultez les exemples plus loin dans cette rubrique pour savoir comment définir le paramètre d’options pour différents scénarios de récupération.

Valeur renvoyée

En cas de réussite, retourne une promesse contenant un objet JSON avec les colonnes récupérées et leurs valeurs. Si l’enregistrement demandé n’existe pas, renvoie une erreur.

Examples

Voici des exemples :

Récupération de base

Récupère le nom et le revenu d’un enregistrement de compte portant l’identifiant d’enregistrement = 5531d753-95af-e711-a94e-000d3a11e605.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name,revenue").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Revenue: " + result.revenue);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

L’exemple ci-dessus affiche le texte suivant dans votre console ; vous pouvez voir d’autres valeurs en fonction de vos données :

Retrieved values: Name: Sample Account, Revenue: 5000000

L’exemple suivant montre comment récupérer le contact pour un enregistrement de compte avec l’identifiant d’enregistrement = a8a19cdd-88df-e311-b8e5-6c3be5a8b200. Pour l’enregistrement de contact associé, nous récupérons uniquement les propriétés contactid et fullname.

Xrm.WebApi.retrieveRecord("account", "a8a19cdd-88df-e311-b8e5-6c3be5a8b200", "?$select=name&$expand=primarycontactid($select=contactid,fullname)").then(
    function success(result) {
        console.log("Retrieved values: Name: " + result.name + ", Primary Contact ID: " + result.primarycontactid.contactid +
                ", Primary Contact Name: " + result.primarycontactid.fullname);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);

L’exemple ci-dessus affiche le texte suivant dans votre console ; vous pouvez voir d’autres valeurs en fonction de vos données :

Retrieved values: Name: Adventure Works, Primary Contact ID: 49a0e5b9-88df-e311-b8e5-6c3be5a8b200, Primary Contact Name: Adrian Dumitrascu

Xrm.WebApi.retrieveMultipleRecords
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é).