Ejemplo de datos de consulta de API web (C#)

  • Artículo

Este ejemplo .NET 6.0 demuestra cómo realizar operaciones de datos comunes utilizando la API web de Dataverse.

Esta muestra utiliza el código auxiliar común de la biblioteca de clases WebAPIService (C#).

Nota

Este ejemplo implementa las operaciones de Dataverse y la salida de la consola detalladas en el Ejemplo de datos de consulta de la API web y utiliza las construcciones comunes de C# que se describen en Ejemplos de API web (C#).

Requisitos previos

Los siguientes elementos son necesarios para compilar y ejecutar este ejemplo:

  • Microsoft Visual Studio 2022.
  • Acceso a Dataverse con privilegios para realizar operaciones de datos.

Cómo ejecutar esta muestra

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

  2. Localizar la carpeta /dataverse/webapi/C#-NETx/QueryData/.

  3. Abrir el archivo QueryData.sln usando Visual Studio 2022

  4. Editar el archivo appsettings.json para establecer los siguientes valores de propiedad:

    Property Instrucciones
    Url La URL para su entorno. Reemplazar el valor de marcador de posición https://yourorg.api.crm.dynamics.com con el valor para su entorno. Consulte Ver recursos para desarrolladores para encontrar esto.
    UserPrincipalName Reemplazar el valor de marcador de posición you@yourorg.onmicrosoft.com con el valor de UPN que usa para acceder al entorno.
    Password Reemplazar el valor de marcador de posición yourPassword con la contraseña que utiliza.

  5. Guarde el archivo appsettings.json

  6. Presione F5 para ejecutar el ejemplo.

Código

El código para este ejemplo está aquí: PowerApps-Samples/dataverse/webapi/C#-NETx/QueryData/Program.cs

Demostraciones

Esta muestra tiene 11 regiones:

Sección 0: Crear registros para consultar

Operaciones: Crear 1 registro account con 9 registros contact relacionados. Cada registro contact tiene 3 registros task relacionados.

Estos son los datos que se usarán en el ejemplo.

Sección 1 Seleccionar propiedades específicas

Operaciones:

  • Usar $select en una entidad de contacto para obtener las propiedades que desea.
  • Incluir anotaciones proporciona acceso a valores formateados con la anotación @OData.Community.Display.V1.FormattedValue

Sección 2 Uso de funciones de consulta

Operaciones:

  • Uso de funciones de consulta estándar (contains, endswith, startswith) para filtrar los resultados.
  • Uso de funciones de consulta de Dataverse (LastXhours, Last7Days, Today, Between, In)
  • Uso de operadores de filtro y operadores lógicos (eq, ne, gt, and, or)
  • Establecer prioridad usando paréntesis ((criteria1) and (criteria2)) or (criteria3)

Sección 3 Pedidos y alias

Operaciones:

  • Usar $orderby
  • Uso de alias parametrizados (?@p1=fullname) con $filter y $orderby

Sección 4 Limitar y contar los resultados

Operaciones:

  • Limitar los resultados usando $top.
  • Obtenga un valor de conteo usando $count.

Sección 5 Paginación

Operaciones:

  • Use el encabezado de solicitud Prefer: odata.maxpagesize para limitar el número de filas devueltas.
  • Use la URL devuelta con la anotación @odata.nextLink para recuperar el siguiente conjunto de registros.

Sección 6 Expandir resultados

Operaciones:

  • $expand con propiedades de navegación de un solo valor.
  • $expand con la propiedad partner.
  • $expand con propiedades de navegación con valores de colección.
  • $expand con múltiples tipos de propiedades de navegación en una sola solicitud.
  • $expand anidado.
  • $expand anidado con propiedades de navegación de un solo valor y valoradas como colección.

Sección 7 Agregación de resultados

Operaciones: Uso de $apply=aggregate con average, sum, min y max.

Sección 8 Consultas FetchXML

Operaciones:

  • Envío de solicitudes usando fetchXml con ?fetchXml=
  • Paginación usando los atributos page y count.

Sección 9 Utilizar consultas predefinidas

Operaciones:

  • Uso de {entitysetname}?savedQuery={savedqueryid} para devolver los resultados de una consulta guardada (vista del sistema)
  • Uso de {entitysetname}?userQuery={userquery} para devolver los resultados de una consulta de usuario (vista guardada)

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. En este ejemplo, todos los registros se eliminan mediante una operación $batch.

Consulte también

Consultar datos utilizando la API web
Ejemplo de datos de consulta de la API web
Usar la API web de Dataverse Ejemplo de operaciones básicas de la API web (C#)
Ejemplo de operaciones condicionales de la API web (C#)
Ejemplo de funciones y acciones de la API web (C#)
Ejemplo de operaciones de esquema de tabla de API web (C#)
Ejemplo de operaciones en paralelo de la API web WebApiService (C#)
Ejemplo de operaciones paralelas de API web con componentes de flujo de datos TPL (C#)

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