HMSyncTOC("index.html", "api_odata_d_queries.htm");

Datos de consultas

<< Haga clic para mostrar la tabla de contenido >>

Datos de consultas

 

Datos de consultas

  •     Introducción
  •     URL del recurso
  •     Ejemplo
  •     Personalizar los atributos retornados
  • Introducción

    Bizagi cuenta con servicios de OData que manejan aspectos del Diseño de experiencia, como se describe en Servicios de datos.

    A través del URI Consultas, puede administrar aspectos relacionados a las formas de consulta provistas a los stakeholders.

     

    Recuerde asegurarse de que ha configurado Consultas en su proyecto, de lo contrario las siguientes funcionalidades pueden resultar en errores o respuestas vacías.

    Para revisar si tiene Consultas configuradas en su proyecto, navegue a la Vista de experto, opción de Entidades y en el árbol busque la hoja de Consultas, la cual está bajo Aplicación > App > Consultas. Al hacer clic en dicha opción, en el panel principal deberán verse sus consultas creadas o puede añadir nuevas.

    Para mayor información acerca de las consultas visite este artículo.

     

    OData_Queries07

     

    URL del recurso

    Comience desde la siguiente URL:

    [URL de su proyecto]/odata/data/queries

     

    Considere:

    [URL de su proyecto]: Corresponde a la URL en la que los usuarios finales acceden el Portal de Trabajo de Bizagi.

    Por ejemplo, para proyectos locales de Bizagi, la URL será:

    https://[servidor]/[proyecto]/odata/data/queries

    Y para proyectos en Automation Service, la URL será:

    https://[ambiente]-[proyecto]-[compañía].bizagi.com/odata/data/queries

     

    Ejemplo

    La siguiente imagen ilustra como se puede enviar un petición de tipo HTTP GET a este recurso:

    Note que la respuesta a la petición HTTP concuerda con las Consultas mostradas en la imagen previamente.

     

    OData_Queries01

     

    Los resultados obtenidos consideran (dentro del elemento value):

    DisplayName: Nombre para mostrar de la Consulta.

    @odata.id: La URL única para acceder a esa consulta en específico.

    Id: String del GUID que representa el URI de la consulta en específico.

     

    note_pin

    En adición a lo anterior, para cada conjunto de resultados enviados por los servicios de OData, la respuesta exitosa incluye un conjunto de propiedades estándar que son prefijadas por el caracter @. Dichas propiedades son descritas en este artículo.

     

    Note que mediante la propiedad @odata.id, puede obtener el detalle de ese registro específico, en vez de la lista completa.

    Por ejemplo:

    [URL de su proyecto]/odata/data/queries([ID_query]):

     

    OData_Queries02

     

    Para una consulta en específico, puede ejecutar mas peticiones y explorar los resultados.

    Para mayor información sobre como ejecutar consultas y navegar sus resultados, refiérase a Ejecutar consultas.

     

    Note que puede obtener también los parámetros de las consultas en general.

    Por ejemplo:

    [URL de su proyecto]/odata/data/queries([ID_query])/parameters

     

    OData_Queries03

     

    Note, revisando la siguiente imagen, que los resultados obtenidos de la invocación al servicio corresponden con los controles añadidos a esa consulta.

     

    OData_Queries08

     

    Puede indagar a fondo un parámetro en específico.

    Por ejemplo:

    [URL de su proyecto]/odata/data/queries([ID_query])/parameters([ID_Param])

    Esta invocación de servicio retornará información detalla respecto al parámetro específico de una consulta dada.

     

    Personalizar los atributos retornados

    En caso de que desee filtrar o cambiar completamente el conjunto de información retornada por estas invocaciones de servicios, refiérase a este artículo.

    En este articulo