Datos de Mis Cosas

<< 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 Mis Cosas

Introducción

Bizagi ofrece un servicio OData que maneja aspectos de Diseño de Experiencia, como se describe en Servicios de datos.

Por medio de la URI de Mis Cosas (Stuff), se puede manejar la información que se maneja en la sección Mis Cosas del Stakeholder con sesión activa.

 

URL del Recurso

Empecemos por la siguiente URL:

[url_del_proyecto_bizagi]/odata/data/stuff

 

Donde:

[url_del_proyecto_bizagi]: Corresponde a la URL donde los usuarios finales acceden al Portal de trabajo de Bizagi.

Por ejemplo, para proyectos de Bizagi en sus instalaciones, esta URL sería:

https://[su_servidor]/[su_proyecto]/odata/data/stuff

Mientras que para proyectos Bizagi PaaS, esta URL sería:

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/odata/data/stuff

 

Ejemplo

La siguiente imagen muestra como se puede enviar una solicitud HTTP GET para este recurso:

 

Data_Stuff

 

 

Los resultados entregados consideran estos valores (dentro del elemento value):

Name: El nombre único para la colección de Mis Cosas, como se definió en Bizagi Studio.

DisplayName: El nombre para mostrar por defecto de la colección de Mis Cosas, como aparece a los usuarios finales en el Portal de Trabajo

@odata.id: La URL única para acceder esa colección en específico de Mis Cosas.

Id: Un GUID en una cadena de texto que representa la URI de esa colección en específico de Mis Cosas.

Actions: La lista de las acciones disponibles para la colección de Mis Cosas.

Este parámetro incluye para cada acción:

oId: Una cadena de texto para el GUID de la acción.

oName: El nombre de la acción.

oDisplayName: El nombre para mostrar de la acción.

oParameters: La lista de los parámetros que se necesitan para disparar esa acción, que en cambio especifica el ID del parámetro, el nombre, el XPath y el tipo de dato (como en Tipos de datos).

Template: La lista de datos (atributos) que la colección de Mis Cosas usa cuando muestra su resumen a través de la plantilla.

Esta plantilla incluye grupos de información que tienen:

oName: Nombre del atributo.

oXPath: El XPath a ese atributo partiendo de la entidad del proceso.

oType: El tipo de dato del atributo. Para una lista de los posibles valores para tipos de datos en Bizagi, refiérase a Tipos de dato.

 

note_pin

En adición a lo mencionado anteriormente, para cada conjunto de resultados entregados por los servicios OData, la respuesta exitosa incluye un grupo de propiedades estándar que son precedidas por el símbolo @. Estas propiedades se describen en Propiedades y opciones de consulta.

 

Dese cuenta cómo por medio de la propiedad @odata.id, puede obtener el detalle de aquel registro únicamente, en vez de una lista.

Por ejemplo, usando

[url_del_proyecto_bizagi]/odata/data/stuff([ID_stuff])

 

OData_Stuff2

 

Partiendo de la invocación anterior, también puede navegar a los valores específicos de una colección en particular.

Por ejemplo, usando

[url_del_proyecto_bizagi]/odata/data/stuff([ID_stuff])/values

 

OData_Stuff3

 

De igual manera, por medio de la propiedad @odata.id, puede obtener solamente los detalles para ese registro en específico, no una lista completa

Por ejemplo, usando

[url_del_proyecto_bizagi]/odata/data/stuff([ID_stuff])/values([ID_valor])

 

OData_Stuff4

 

note_pin

Con el objetivo de promover un rendimiento óptimo, las imágenes o adjuntos no son retornados de manera inmediata por la misma invocación del servicio.

A su vez, una URL se entrega para que pueda consultar tal imagen o adjunto de manera separada.

Para aprender más sobre esta opción, consulte URLs para imágenes y adjuntos.

 

Puede también navega y explorar elementos específicos de las colecciones de Mis Cosas del Stakeholder autenticado, como las acciones disponibles para cada registro de estas colecciones.

Para mayor información sobre cómo continuar la navegación hacia las acciones que disparan procesos desde Mis Cosas, refiérase a Datos de Acciones de Mis Cosas.

 

Note que también puede obtener las acciones disponibles de las colecciones de Mis Cosas en general.

Por ejemplo usando:

[your_bizagi_project_url]/odata/data/stuff([ID_stuff])/actions

 

OData_Stuff8

 

 

Personalizando los atributos entregados

En en caso de que quiera filtrar o cambiar completamente el conjunto de atributos que retornan información de esta invocación, refiérase a Configurar qué información de negocio se retorna.