Compartilhar via

retrieveMultipleRecords

Recupera uma coleção de registros de tabela.

Disponível para

Aplicativos baseados em modelos e portais.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
entityLogicalName String Yes O nome lógico da tabela dos registros que você deseja recuperar. Por exemplo: "conta".
opções String Não

Opções de consulta do sistema OData ou consulta FetchXML para recuperar seus dados.

  • Há suporte para as seguintes opções de consulta do sistema: $select, $top, $filter, $expand e $orderby.
  • Para especificar uma consulta FetchXML, use a fetchXml coluna para especificar a consulta.

OBSERVAÇÃO: você sempre deve usar a opção de consulta do sistema $select para limitar as propriedades retornadas para um registro de tabela, incluindo uma lista separada por vírgulas de nomes de propriedades. Limitar as colunas que você recupera é uma prática recomendada de desempenho importante. Se as propriedades não forem especificadas usando $select, todas as propriedades serão retornadas.

Você especifica as opções de consulta começando com ?. Você também pode especificar várias opções de consulta do sistema usando & para separar as opções de consulta.

maxPageSize Número Não

Especifique um número positivo que indica o número de registros de tabela a serem retornados por página. Se você não especificar esse parâmetro, o valor padrão será passado como 5.000.

Se o número de registros recuperados for maior do que o valor especificado maxPageSize , nextLink a coluna no objeto promise retornado conterá um link para recuperar o próximo conjunto de tabelas.

sucessoRetorno de chamada Função Não

Uma função a ser chamada quando os registros de tabela são recuperados. Um objeto com as seguintes colunas é passado para a função:

  • entidades: uma matriz de objetos JSON, em que cada objeto representa o registro de tabela recuperado que contém colunas e seus valores como key: value pares. A ID do registro da tabela é recuperada por padrão.
  • nextLink: Cadeia de caracteres. Se o número de registros que estão sendo recuperados for maior do que o valor especificado no maxPageSize parâmetro na solicitação, essa coluna retornará a URL para retornar o próximo conjunto de registros.
erroRetorno de chamada Função Não Uma função a ser chamada quando a operação falhar.

Valor de retorno

Tipo: Promise<RetrieveMultipleResponse>

Descrição: Retorna RetrieveMultipleResponse uma promessa que contém uma matriz de objetos JSON contendo os registros de tabela recuperados e o parâmetro nextLink com a URL apontando para o próximo conjunto de registros no caso de paginação (maxPageSize) ser especificada na solicitação e a contagem de registros retornada excede o valor de paginação. Ele tem os seguintes parâmetros:

parâmetro Valor de retorno Description
entities Entity[] Uma matriz de objetos JSON, em que cada objeto representa o registro de tabela recuperado que contém colunas e seus valores.
nextLink string Se o número de registros recuperados for maior do que o valor especificado no parâmetro 'maxPageSize' na solicitação, esse parâmetro retornará a URL para retornar o próximo conjunto de registros.

Web API
Referência da API da estrutura de componentes do Power Apps
Visão geral da estrutura de componentes do Power Apps

  • Last updated on