Compartir a través de

Ejemplo de datos de consulta de API web (PowerShell)

En este ejemplo de PowerShell versión 7.4.0 se muestra cómo realizar varias operaciones de consulta en las filas de tabla de Microsoft Dataverse mediante la API web de Dataverse. En este ejemplo se implementan operaciones de Dataverse y el output de la consola detallado en el Ejemplo de consulta de datos de API web.

Ver este ejemplo en Github

Esta muestra utiliza las Funciones auxiliares de PowerShell de la Web API de Dataverse para gestionar la autenticación y proporcionar funciones reutilizables para realizar operaciones comunes. Se hace referencia a estos scripts utilizando abastecimiento de puntos con las siguientes líneas:

. $PSScriptRoot\..\Core.ps1
. $PSScriptRoot\..\TableOperations.ps1
. $PSScriptRoot\..\CommonFunctions.ps1

Nota:

Esta muestra debería funcionar con Windows, Linux y macOS, pero solo se ha probado en Windows.

Prerrequisitos

Antes de ejecutar este ejemplo, debe leer estos artículos que explican los conceptos y patrones utilizados en estos ejemplos:

Estos artículos tienen los mismos requisitos previos.

Instale o verifique que lo siguiente esté instalado

Comprobar la instalación

  1. Abre Visual Studio Code.

  2. En el menú Terminal, seleccione Nuevo terminal.

  3. En el panel de navegación de Visual Studio Code, seleccione el icono para la extensión de PowerShell.

  4. Copie y pegue el siguiente script en la ventana de la terminal de Visual Studio Code:

    Write-Host 'PowerShell Version:'$PSVersionTable.PSVersion.ToString()
Write-Host 'PowerShell Az version:'(Get-InstalledModule Az).Version

  5. Presione ENTRAR. La salida debe ser similar a la siguiente:

    PowerShell Version: 7.4.0
PowerShell Az version: 11.1.0

Si no ve resultados como este, instale o actualice los requisitos previos.

También necesitará

  • Cuenta de usuario válida para un entorno de Dataverse
  • Dirección URL al entorno de Dataverse al que desea conectarse Consulte Ver recursos para desarrolladores para saber cómo encontrarlo. Se parece a esto: https://yourorg.crm.dynamics.com/, donde yourorg.crm es diferente.
  • Comprensión básica de lenguaje de scripting PowerShell

Cómo ejecutar esta muestra

  1. Clonar o descargar el repositorio de ejemplos de PowerApps.

  2. Abrir el archivo QueryData.ps1 utilizando Visual Studio Code

  3. Edite esta línea para usar la URL del entorno al que quiere conectarse:

    Connect 'https://yourorg.crm.dynamics.com/' # change this

  4. (Opcional) Configure la variable $deleteCreatedRecords a $false si no desea eliminar los registros que crea esta muestra.

  5. Presione F5 para ejecutar el ejemplo.

  6. La primera vez que ejecuta el ejemplo se abre una ventana del navegador. En la ventana del navegador, ingrese o seleccione las credenciales que desea usar para autenticarse.

Para conectarse como un usuario diferente, ejecute el Comando Disconnect-AzAccount e inténtelo de nuevo.

Código

El código de este ejemplo se encuentra en: PowerApps-Samples/dataverse/webapi/PS/QueryData/QueryData.ps1

Demostraciones

Esta muestra tiene 11 regiones:

Sección 0: Crear registros para consultar

Operaciones: cree un registro de cuenta con registros de contacto relacionados, y cada contacto tenga registros de tareas relacionados. Estos son los datos de ejemplo que se usan en toda la demostración.

Sección 1: Selección de propiedades específicas

Operaciones:

  • Utilice la opción de consulta del sistema $select para recuperar propiedades específicas.
  • Incluir el Prefer: odata.include-annotations="*" encabezado para obtener valores con formato.

Sección 2: Uso de funciones de consulta

Operaciones:

  • Use funciones de consulta estándar como contains, endswithy startswith para filtrar los resultados.
  • Use funciones de consulta específicas de Dataverse como LastXHours, Last7Days, Today, Betweeny In.
  • Use operadores de filtro y operadores lógicos (eq, ne, gt, and, or).
  • Establezca precedencia mediante paréntesis en expresiones de filtro.

Sección 3: Pedidos y alias

Operaciones:

  • Use $orderby para ordenar los resultados de la consulta.
  • Use alias con parámetros con $filter y $orderby para simplificar las consultas.

Sección 4: Limitar y contar los resultados

Operaciones:

  • Use $top para limitar el número de resultados devueltos.
  • Use $count para obtener el recuento total de registros que coinciden con la consulta.

Sección 5: Paginación

Operaciones:

  • Use el encabezado de solicitud Prefer: odata.maxpagesize para controlar el tamaño de página.
  • Use la @odata.nextLink anotación para recuperar las páginas posteriores de los resultados.

Sección 6: Expandir los resultados

Operaciones:

  • Use $expand con propiedades de navegación de un solo valor para incluir registros relacionados.
  • Usar $expand con propiedades de navegación valoradas como colección.
  • Use $expand con varias propiedades de navegación en una sola solicitud.
  • Usar $expand anidadas a fin de recuperar varios niveles de registros relacionados.

Sección 7: Agregación de resultados

Operaciones: use $apply=aggregate con funciones como average, sum, miny max para calcular valores agregados.

Sección 8: Consultas FetchXML

Operaciones:

  • Enviar solicitudes mediante FetchXML con el parámetro de cadena de consulta de fetchXml.
  • Use la paginación con FetchXML mediante los page atributos y count .

Sección 9: Uso de consultas predefinidas

Operaciones:

  • Ejecute una consulta guardada (vista del sistema) mediante el parámetro savedQuery.
  • Ejecute una consulta de usuario (vista guardada) usando el parámetro userQuery.

Sección 10: Eliminar registros de muestra

Operaciones: se agregó una referencia a cada registro creado en esta muestra a una lista a medida que se creaba. Esta sección recorre esa lista y elimina cada registro.

Limpieza

De forma predeterminada, esta muestra elimina todos los registros creados en ella. Si desea ver los registros creados después de completar la muestra, cambie la variable deleteCreatedRecords a false y se le pedirá que decida si desea eliminar los registros.

Consulte también

Usar la API web de Dataverse
Consultar datos utilizando la API web
Inicio rápido de la API web con PowerShell y Visual Studio Code
Usar PowerShell y Visual Studio Code con la API web de Dataverse
Ejemplos de la API Web
Ejemplo de datos de consulta de la API web
Ejemplo de datos de consulta de API web (C#)
Ejemplo de datos de consulta de la API web (JavaScript del lado del cliente)

  • Last updated on