Servicios Metadata

<< 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 Metadata

Introducción

Bizagi ofrece servicios OData para que aplicaciones externas puedan trabajar con la información que tiene Bizagi.

Hay dos tipos diferentes de servicios OData: uno maneja las definiciones del usuario (datos) y el otro maneja las definiciones almacenadas en las entidades de sistema y paramétricas (metadata), como se describe en API de Bizagi.

Esta sección describe como hacer uso de los servicios OData que manejan metadata (referido de ahora en adelante como Servicios metadata).

 

Importante

Los Servicios metadata en Bizagi no consideran el contexto ni la información relevante para un usuario específico (Stakeholder), aunque haya una petición autenticada.

Estos servicios no retornan información de negocio en sí.

 

note_pin

Los recursos de Servicios metadata están disponibles por medio de acciones HTTP GET.

 

URL base para Servicios metadata

Para acceder los Servicios metadata, necesitará parte de la siguiente URL base:

[url_del_proyecto_bizagi]/odata/metadata

 

Siendo:

[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

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

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

 

Recursos en Servicios metadata

La siguiente tabla muestra información sobre los recursos manejados por Servicios metadata:

 

Recurso

Descripción

URL ejemplo

Processes

Entrega una lista de todos los procesos.

Para mayor información sobre este recurso y sus recursos u opciones de consulta, refiérase a Metadata de procesos.

[url_del_proyecto_bizagi]/odata/metadata/processes

Stakeholders

Entrega una lista de todos los Stakeholders disponibles.

Para mayor información sobre este recurso y sus recursos u opciones de consulta, refiérase a Metadata de Stakeholder.

[url_del_proyecto_bizagi]/odata/metadata/stakeholders

getProject

Entrega los detalles del proyecto actual.

Para mayor información sobre este recurso, refiérase a Metadata de Proyecto.

[url_del_proyecto_bizagi]/odata/metadata/getProject

 

Tenga en cuenta que la definición de estos recursos está dada por una acción HTTP GET con la URL base ([url_del_proyecto_bizagi]/odata/metadata):

{

 "@odata.context": "[url_del_proyecto_bizagi]/odata/metadata/$metadata",

 "value": [

   {

     "name": "stakeholders",

     "kind": "EntitySet",

     "url": "stakeholders"

   },

   {

     "name": "processes",

     "kind": "EntitySet",

     "url": "processes"

   }

 ]

}