Recuperar y ejecutar consultas predefinidas

Microsoft Dataverse proporciona una forma de que los administradores creen vistas del sistema que están disponibles para todos los usuarios. Los usuarios individuales pueden guardar consultas de búsqueda avanzada para su reutilización en la aplicación. Ambas representan consultas predefinidas que puede recuperar y ejecutar utilizando la API web.

Nota

A diferencia de las consultas que utilizan la sintaxis de OData, los datos devueltos de consultas predefinidas o fetchXml no devolverán propiedades con valores null. Cuando el valor es null, la propiedad no se incluirá en los resultados.

Cuando se devuelve una consulta utilizando la sintaxis de OData, un registro incluirá una propiedad con un valor null así:

{
    "@odata.etag": "W/\"46849433\"",
    "name": "Contoso, Ltd. (sample)",
    "accountnumber": null,
    "accountid": "7a4814f9-b0b8-ea11-a812-000d3a122b89"
}

Cuando se recupera mediante una consulta predefinida o con FetchXml, el mismo registro no incluirá la propiedad accountnumber porque es null, al igual que:

{
    "@odata.etag": "W/\"46849433\"",
    "name": "Contoso, Ltd. (sample)",
    "accountid": "7a4814f9-b0b8-ea11-a812-000d3a122b89"
}

Consultas predefinidas

Dataverse permite definir, guardar, y ejecutar dos tipos de consultas que se muestran aquí.

Tipo de consulta	Descripción
Consulta guardada	Vistas definidas por el sistema para una tabla (entidad). Estas vistas se almacenan en savedquery EntityType. Más información: Personalizar vistas de tabla
Consulta de usuario	Búsqueda avanzada búsquedas guardadas por los usuarios para una tabla (entidad). Estas vistas se almacenan en userquery EntityType. Más información: Tabla UserQuery (vista guardada)

Los registros para ambos tipos de entidades contienen la definición FetchXML para que se devuelvan los datos. Puede buscar el tipo de entidad respectivo para recuperar el valor de clave principal. Con el valor de clave principal, puede ejecutar la consulta pasando el valor de clave principal. Por ejemplo, para ejecutar la consulta guardada Cuentas activas, primero debe obtener la clave principal mediante una consulta como ésta.

GET [Organization URI]/api/data/v9.0/savedqueries?$select=name,savedqueryid&$filter=name eq 'Active Accounts'

Luego puede usar el valor de savedqueryid y pasarlo como el valor al parámetro savedQuery al conjunto de entidades de cuentas.

GET [Organization URI]/api/data/v9.0/accounts?savedQuery=00000000-0000-0000-00aa-000010001002

Utilice el mismo enfoque para obtener el userqueryid y pasarlo como valor al parámetro userQuery al conjunto de entidades que coincide con el correspondiente returnedtypecode de la consulta guardada.

GET [Organization URI]/api/data/v9.0/accounts?userQuery=121c6fd8-1975-e511-80d4-00155d2a68d1

Aplicar una consulta a cualquier colección del tipo adecuado

Además de simplemente aplicar la consulta guardada a la colección principal del conjunto de entidades, también puede usar una consulta guardada o consulta de usuario para aplicar el mismo filtrado a cualquier colección del tipo adecuado de entidades. Por ejemplo, si desea aplicar una consulta solo a entidades relacionadas con una entidad específica, puede aplicar el mismo patrón. Por ejemplo, la siguiente URL aplicará la consulta Oportunidades abiertas a las oportunidades relacionadas con una cuenta específica a través de la propiedad de navegación valorada como colección opportunity_parent_account.

GET [Organization URI]/api/data/v9.0/accounts(8f390c24-9c72-e511-80d4-00155d2a68d1)/opportunity_parent_account/?savedQuery=00000000-0000-0000-00aa-000010003001

Consulte también

Ejemplo de datos de consulta API (C#)
Ejemplo de datos de consulta de la API web (JavaScript del lado del cliente)
Realizar operaciones mediante la API web
Componer solicitudes HTTP y administrar errores
Consultar datos utilizando la API web
Crear una fila de tabla usando la API web
Recuperar una fila de tabla usando la API web
Actualizar y eliminar filas de tablas usando la API web
Asociar y anular la asociación de filas de tabla mediante la API web
Usar funciones de la API web
Usar acciones de la API web
Ejecute las operaciones por lotes mediante API web
Suplantar a otro usuario utilizando la API web
Realizar operaciones condicionales mediante la API web

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