retrieveRecord (Référence API JavaScript) pour l’environnement d’intégration du canal de Dynamics 365 1.0

  • Article

Récupère un enregistrement d’entité.

Syntaxe

Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, options).then(successCallback, errorCallback);

Paramètres

Nom  Type Requise Description
entityLogicalName Chaîne Oui Nom logique d’entité de l’enregistrement à récupérer. Par exemple : « compte ».
Id Chaîne Oui GUID de l’enregistrement d’entité à extraire.
options Chaîne Non

Options de requête 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. C’est une pratique recommandée importante. 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 entités 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.

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)
successCallback Fonction Non

Fonction à appeler lorsqu’un enregistrement est récupéré.
errorCallback Fonction Non Fonction à appeler lorsque l’opération échoue.

Valeur renvoyée

En cas de réussite, retourne une promesse contenant la chaîne avec les attributs récupérés et leurs valeurs.

Exemples

Cet exemple de code récupère le nom et le numéro de téléphone d’un enregistrement de contact avec l’ID = a8a19cdd-88df-e311-b8e5-6c3be5a8b200.

// retrieve contact record
var id = "b44d31ac-5fd1-e811-8158-000d3af97055";
var entityLogicalName = "contact";
Microsoft.CIFramework.retrieveRecord(entityLogicalName, id, "?$select=fullname,telephone1").then(
    function success(result) {
      res=JSON.parse(result);
        console.log(`Retrieved values: Full Name: ${res.fullname}, Telephone Number: ${res.telephone1}`);
        // perform operations on record retrieval
    },
    function (error) {
        console.log(error.message);
        // handle error conditions
    }
);