Metadata de Búsquedas 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 Búsquedas 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 Búsquedas para un Stakeholder dado.

 

URL del Recurso

Empecemos con la siguiente URL:

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

 

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_SSearches

 

Los resultados de esta petición son los siguientes (dentro del elemento value):

Name: El nombre único de la búsqueda para ese Stakeholder.

DisplayName: El nombre para mostrar por defecto de la búsqueda, como lo ve el Stakeholder.

@odata.id: La URL única para acceder a esa búsqueda en específico.

Id: Una cadena de texto con el GUID que representa la URI para esa búsqueda en específico.

Parameters: La lista de datos (atributos) que esa búsqueda necesita para realizar una nueva.

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.

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

Estos parámetros incluyen para cada acción:

oId: El GUID de la acción en una cadena de texto.

oName: El nombre único de la acción.

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

oParameters: La lista de los parámetros necesarios para ejecutar esta acción, que especifica ID, nombre, Xpath y tipo de dato del parámetro (de acuerdo a Tipos de datos).

Template: La lista de datos (atributos) que esta búsqueda usa cuando muestra los registros que coinciden.

Este template 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.

 

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])/searches([GUID])

 

OData_SSearches2