Introducción
Bizagi ofrece un servicio OData que maneja aspectos de Diseño de Experiencia, como se describe en Servicios metadata.
Por medio de la URI de Procesos, se puede manejar la información que se relaciona con los Procesos de un proyecto.
URL del Recurso
Empecemos con la siguiente URL:
[url_del_proyecto_bizagi]/odata/metadata/processes
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/metadata/processes
Mientras que para proyectos Automation Service, esta URL sería:
https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañía].bizagi.com/odata/metadata/processes
|
Este recurso está disponible por medio de una acción HTTP GET. |
Ejemplo
La siguiente imagen muestra como se puede enviar una solicitud HTTP GET para este recurso:
Los resultados de esta petición son los siguientes (dentro del elemento value):
•Name: El nombre único del proceso disponible para ese Stakeholder, como se definió en Bizagi Studio.
•DisplayName: El nombre para mostrar por defecto del proceso, como lo ve el Stakeholder y los usuarios finales en el Portal de Trabajo.
•@odata.id: La URL única para acceder a ese proceso en específico disponible para ese Stakeholder.
•Id: Una cadena de texto con el GUID que representa la URI para ese proceso en específico para ese Stakeholder.
•Parameters: La lista de datos (atributos) que ese proceso necesita para realizar uno nuevo.
Estos parámetros incluyen para cada atributo:
oId: El GUID del atributo en una cadena de texto.
oName: El nombre para mostrar del atributo.
oXPath: El XPath completo para ese atributo (incluye su nombre).
oType: El tipo de dato de ese atributo. Para una lista de los posibles valores de tipos de dato en Bizagi, refiérase a Tipos de datos.
•Template: La lista de datos (atributos) que este proceso usa cuando muestra su resumen en la plantilla.
Este plantilla incluye conjuntos de información, que tienen:
oName: El nombre del atributo.
oXPath: El XPath a ese atributo partiendo de la entidad de proceso.
oType: El tipo de dato de ese atributo. Para una lista de los posibles valores de tipos de dato en Bizagi, refiérase a Tipos de datos.
|
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, haciendo uso de
[url_del_proyecto_bizagi]/odata/metadata/processes([ID_proceso])
Partiendo de la invocación anterior, también puede navegar a otra información específica de los procesos, como las acciones disponibles para cada uno de ellos.
Por ejemplo, usando:
[url_del_proyecto_bizagi]/odata/metadata/processes([ID_proceso])/actions
Autorización
Para restringir el acceso al servicio de metadata de Procesos, debe ir a la vista Experto de Bizagi Studio. Una vez allí, seleccione la opción Seguridad y expanda los siguientes nodos: Autorización > Páginas > Casos. Después de expandir este último, busque la opción Nuevo Caso y haga clic en ella.
En la ventana que aparece, agregue y seleccione los Grupos de usuarios, Roles de usuario o Stakeholders para los que desea configurar permisos de acceso al servicio en el panel Grupos de usuarios y roles. Luego, restrinja el acceso al servicio haciendo clic en el botón Denegar en la opción Acceso del panel Permisos. Finalmente, haga clic en el botón OK para mantener sus cambios.
|
Tenga en cuenta que por defecto se puede acceder al servicio sin restricciones. |
