Valores de entidades relacionadas

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Conceptos básicos > Servicios de consulta >

Valores de entidades relacionadas

Introducción

Bizagi provee servicios OData, que manejan un amplio conjunto de recursos, alguno de ellos le permiten usar un servicio HTTP POST para iniciar un nuevo caso, completar una actividad o evento (workitem) pendiente o disparar una acción.

Para usar estos servicios basados en HTTP POST usted necesitará revisar ciertas estructuras de datos y parámetros de entrada.

 

La siguiente sección describe cómo realizar consultas de valores de una entidad relacionada, tal como una que se muestra típicamente como una lista desplegable, para que pueda enviar un valor adecuado cuando inicia un nuevo proceso, completando un workitem o disparando una acción.

 

Alcance del recurso

El recurso para obtener las entidades relacionadas se ejecuta por medio del método HTTP GET, y le permite obtener cuáles entidades referenciadas son usadas por un proceso (aquellos atributos de tipo entidad, en inglés Entity), ya sea usado por una forma de inicio (cuando se desea crear un nuevo caso), en una forma de actividad (cuando se desea completar un workitem) o usado como entrada para una acción (cuando se desea disparar una).

 

OData_Related1

 

URL del recurso

La posibilidad de consultar valores para entidades relacionadas es soportada por todos estos recursos:

[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/cases([ID_caso])/workitems([ID_workitem])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/cases([ID_caso])/workitems([ID_workitem])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/stuff([ID_mis_cosas])/values([ID_valor])/actions([ID_acción])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/searches([ID_búsqueda])/actions([ID_acción])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/searches([ID_búsqueda])/results([ID_result])/actions([ID_acción])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/relevants([ID_relevante])/relatedEntities

[url_del_proyecto_bizagi]/odata/data/relevants([ID_relevante])/actions([ID_acción])/relatedEntities

 

Ejemplo

La siguiente imagen muestra como se puede enviar un HTTP GET para este recurso, al usar como ejemplo lo siguiente:

[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/relatedEntities

 

Siendo:

[ID_proceso]: El GUID del proceso como se retorna cuando se consulta [url_del_proyecto_bizagi]/odata/data/processes

 

OData_Related2

 

Los resultados entregados tienen en cuenta varios valores, una para cada una de las entidades usadas por el proceso, actividad o acción (típicamente en una lista desplegable).

Dentro del elemento value, encontrará:

Name: El nombre del atributo como una entidad referenciada.

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

Id: Una cadena de texto con el GUID que representa la URI de esa referencia.

XPath: El XPath al atributo partiendo de la entidad de proceso.

 

note_pin

Adicionalmente, para cada conjunto de resultados entregado por los servicios OData, la respuesta exitosa incluye un grupo de propiedades estándar que están precedidas por el símbolo @. Estas propiedades se describen en Propiedades y opciones de consulta.

 

Por medio de la propiedad @odata.id, puede obtener el detalle de registo selecionado, en lugar de una lista completa, usando:

[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/relatedEntities([ID_entidad_relacionada])

 

Sin embargo, partiendo de la invocación anterior, usted deberia navegar a los valores que son posibles para la entidad relaciodada dada, por medio de:

[url_del_proyecto_bizagi]/odata/data/processes([ID_proceso])/relatedEntities([ID_entidad_relacionada])/values

 

OData_Related3

 

Los resultados recibidos tienen varios valores, uno para cada uno de los valores posibles de un registro existente de esa entidad.

Dentro del elemento value, considere relevante la siguiente información:

label: El nombre para mostrar o la etiqueta para ese registro.

value: El identificador único para ese registro.

Cuando una entidad tiene definida una llave de negocio, que esté compuesta por un atributo, el valor retornado será el valor contenido por el atributo de la llave de negocio.

Por otra parte, si la llave de negocio está compuesta por más de un atributo, o no está explícitamente definida para esa entidad, este valor será un GUID.

Este valor, sin importar que sea GUID o no, es el que se debe enviar como parámetro de entrada para cualquiera de los escenarios mencionados anteriormente (iniciar un proceso, completar una actividad o evento pendiente o lanzar una acción).

 

Note que el ejemplo anterior muestra un GUID. El ejemplo a continuación muestra el valor cuando la entidad tienen una llave de negocio atada a un único atributo:

 

OData_Related4