Compartir a través de

retrieveMultipleRecords

  • Artículo

Recupera una colección de registros de tabla.

Disponible para

Aplicaciones basadas en modelos y portales.

Sintaxis

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

Parámetros

Nombre Tipo Obligatorio Descripción
entityLogicalName String Sí El nombre lógico de la tabla de los registros que desea recuperar. Por ejemplo: "cuenta".
options String No

Opciones de consulta del sistema OData o FetchXML consulta para recuperar sus datos.

  • Se admiten las siguientes opciones de consulta del sistema: $select, $top, $filter, $expand y $orderby.
  • Para especificar una consulta FetchXML , utilice la columna fetchXml para especificar la consulta.

Nota: Siempre debe utilizar la opción de consulta del sistema $select para limitar las propiedades que se devuelven para un registro de tabla, incluida una lista separada por comas de nombres de propiedades. Limitar las columnas que recupera es una práctica recomendada de rendimiento importante. Si las propiedades no se especifican con $select, se devolverán todas las propiedades.

Especifique las opciones de consulta comenzando con ?. También puede especificar varias opciones de consulta del sistema usando & para separar las opciones de consulta.

maxPageSize Número No

Especifique un número positivo que indique el número de registros de tabla que se volverán por página. Si no especifica este parámetro, el valor predeterminado se pasa como 5000.

Si el número de registros recuperados es superior al valor maxPageSize especificado, la columna nextLink en el objeto de promesa devuelto contendrá un vínculo para recuperar el siguiente conjunto de tablas.

successCallback Function No

Una función para llamar cuando se recuperan registros de tabla. Se pasa a la función un objeto con las siguientes columnas:

  • entidades: matriz de objetos JSON, donde cada objeto representa el registro de tabla recuperado que contiene las columnas y sus valores como pares key: value. De forma predeterminada se recupera el identificador del registro de tabla.
  • nextLink: cadena. Si el número de registros que se están recuperando es mayor que el valor especificado en el parámetro maxPageSize en la solicitud, esta columna devuelve la dirección URL para devolver el siguiente conjunto de registros.
errorCallback Función No Una función a la que se llama cuando la operación tiene error.

Valor devuelto

Tipo: Promesa<RetrieveMultipleResponse>

Descripción: RetrieveMultipleResponse devuelve una sugerencia que contiene una matriz de objetos JSON (entidades) que contienen los registros de tabla recuperados y el parámetro nextLink (opcional) con la dirección URL apuntando al siguiente conjunto de registros en el caso de haberse especificado paginación (maxPageSize) en la solicitud y si el número de registros devuelto supera el valor de paginación. Tiene los siguientes parámetros:

parámetro Valor devuelto Descripción
entities Entity[] Una matriz de objetos JSON, donde cada objeto representa el registro de tabla recuperado que contiene las columnas y sus valores.
nextLink string Si el número de registros que se están recuperando es mayor que el valor especificado en el parámetro 'maxPageSize' en la solicitud, este parámetro devuelve la dirección URL para devolver el siguiente conjunto de registros.

API web
Referencia de la API de Power Apps component framework
Información general sobre Power Apps component framework

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).