Datos de entidades

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Índice de servicios > Servicios de Datos >

Datos de entidades

Introducción

Bizagi cuenta con servicios de OData para manejar aspectos del Diseño de experiencia, como se describe en Servicios de Datos.

Mediante la URI Entities, puede manejar los datos relacionados a Entidades administrables, las cuales son Entidades paramétricas y Stakeholders.

 

Recuerde asegurarse de haber configurado entidades adminsitrables, tales como entidades paramétricas, en su proyecto. De lo contrario los servicios descritos en este artículo pueden resultar en errores o respuestas vacías.

Para revisarlo, navegue a Vista de experto, opción entidades y expanda el nodo de parámetros. Cuando haga clic en el nodo valores de la entidad paramétrica, en el panel principal encontrará una lista de los valores que han sido configurados, tal como se muestra en la imagen.

 

OData_Entities02

 

URL del recurso

Comience desde la siguiente URL:

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

 

Considere:

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

Por ejemplo, para un proyecto local de Bizagi la URL será:

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

Y para proyectos en <%BIZAGI_CLOUD%>, dicha URL será:

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

 

Ejemplo

La siguiente imagen ilustra como puede enviar una petición HTTP GET a este recurso.

Note que en la respuesta de la invocación del servicio la lista de los atributos corresponde a los de la entidad mostrados en la imagen previa.

 

OData_Entities01

 

 

Los resultados retornados consideran (bajo el elemento value):

DisplayName: El nombre para mostrar de la entidad.

@odata.id: La URL única para acceder a este recurso.

Id: Un GUID expresado como String que representa el URI del recurso.

name: El nombre de la entidad como fue almacenado en el modelo de datos.

Type: Tipo de la entidad.

Template: Objeto que contiene una lista de los atributos de la entidad.

oName: Nombre del atributo.

oXpath: Xpath para acceder al atributo.

oType: tipo de dato del atributo como fue configurado en el modelo de datos.

 

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 en la propiedad @odata.id puede obtener los detalles del registro en específico, en vez de la lista completa.

Por ejemplo:

[URL de su proyecto]/odata/data/entities([ID_entity]):

 

OData_Entities03

 

Note que puede obtener valores establecidos para una entidad.

Por ejemplo:

[URL de su proyecto]/odata/data/entities([ID_entity])/values

 

OData_Entities04

 

Y puede investigar un valor específico.

Por ejemplo:

[URL de su proyecto]/odata/data/entities([ID_entity])/values([ID_value])

Que le traerá información adicional del valor específico de la entidad.

 

OData_Entities05

 

Personalizar los atributos retornados

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