retrieveMultipleRecords

  • Article

Récupère une collection d’enregistrements de table.

Disponible pour

Applications pilotées par modèle et portails.

Syntaxe

context.webAPI.retrieveMultipleRecords(entityLogicalName, options, maxPageSize).then(successCallback, errorCallback);

Paramètres

Nom Type Obligatoire Description
entityLogicalName String Oui Nom logique de la table des enregistrements à récupérer. Par exemple : "compte".
options String No

Options de requête du système OData ou FetchXML requête pour récupérer vos données.

  • Les options de requête système suivantes sont prises en charge : $select, $top, $filter, $expand, et $orderby.
  • Pour spécifier une FetchXML requête, utilisez la fetchXml colonne pour spécifier la requête.

REMARQUE : vous devez toujours utiliser l’option de requête système $select pour limiter les propriétés retournées pour un enregistrement de table en y insérant une liste de noms de propriété séparés par des virgules. Limiter les colonnes que vous récupérez est une pratique recommandée 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.

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

maxPageSize Nombre Non

Spécifiez un nombre positif qui indique le nombre d’enregistrements de table à retourner par page. Si vous ne spécifiez pas ce paramètre, la valeur par défaut passe à 5 000.

Si le nombre d’enregistrements récupérés excède la valeur maxPageSize spécifiée, la colonne nextLink dans l’objet promise retourné contient un lien pour récupérer le prochain ensemble de tables.

successCallback Function Non

Fonction à appeler lorsque des enregistrements de table sont récupérés. Un objet avec les colonnes suivantes est passé à la fonction :

  • entities : tableau d’objets JSON, où chaque objet représente les enregistrements de table récupérés contenant des colonnes et leurs valeurs sous la forme de paires key: value. L’ID de l’enregistrement de table est extrait par défaut.
  • nextLink : chaîne. Si le nombre d’enregistrements récupérés est supérieur à la valeur spécifiée dans le paramètre maxPageSize de la demande, cette colonne retourne l’URL pour retourner le prochain jeu d’enregistrements.
errorCallback Fonction Non Fonction à appeler lorsque l’opération échoue.

Valeur renvoyée

Taper : Promesse<RetrieveMultipleResponse>

Description : la RetrieveMultipleResponse retourne une promesse qui contient un groupe d’objets JSON (entités) contenant les enregistrements de table et le paramètre nextLink récupérés avec l’URL indiquant le prochain jeu d’enregistrements si la pagination (maxPageSize) est spécifiée et le nombre d’enregistrements renvoyés est égal à la valeur de pagination. Elle contient les paramètres suivants :

paramètre Valeur renvoyée Description
entities Entity[] Tableau d’objets JSON, où chaque objet représente les enregistrements de table récupérés contenant des colonnes et leurs valeurs.
nextLink string Si le nombre d’enregistrements récupérés est supérieur à la valeur spécifiée dans le paramètre « maxPageSize » de la demande, ce paramètre retourne l’URL pour retourner le prochain jeu d’enregistrements.

API web
Référence des API Power Apps component framework
Vue d’ensemble de Power Apps component framework

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