Metadata de Mis Cosas del Stakeholder

<< Clic para mostrar Tabla de Contenidos >>

Navegación:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios OData > Servicios Metadata > Metadata de Stakeholders >

Metadata de Mis Cosas del Stakeholder

Introducción

Bizagi ofrece un servicio OData que maneja aspectos de Diseño de Experiencia.

Por medio de la URI de Stakeholders, se puede manejar la metadata que se relaciona con los Stakeholders de un proyecto, y cuando se navega para un Stakeholder en específico con su ID se puede manejar Mis Cosas, Búsquedas o Procesos Relevantes, como se describe en Metadata de Stakeholders.

Esta sección describe como consultar las colecciones para un Stakeholder dado en Mis Cosas.

 

URL del Recurso

Empecemos con la siguiente URL:

[url_del_proyecto_bizagi]/odata/metadata/stakeholders([stakeholder_ID]/stuff)

 

Donde:

[stakeholder_ID]: El GUID de un Stakeholder en específico, que es retornado al invocar el servicio Metadata de Stakeholders.

[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]/oauth2/server/token

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

https://[ambiente_del_proyecto]-[su_proyecto]-[su_compañia].bizagi.com/oauth2/server/token

 

 

note_pin

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:

 

OData_SMyStuff

 

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, haciendo uso de:

[url_del_proyecto_bizagi]/odata/metadata/stakeholders([stakeholder_ID])/stuff([GUID])

 

OData_SMyStuff2

 

 

Partiendo de la invocación anterior, también puede navegar a los valores específicos de una colección en particular de Mis Cosas, como las acciones disponibles para cada registro de las colecciones.

Por ejemplo, usando

[url_del_proyecto_bizagi]/odata/metadata/stakeholders([stakeholder_ID])/stuff([GUID])/actions

 

OData_MetadataActions