Índice de servicios

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

Introducción

Cuando se utiliza el API de OData de Bizagi, los siguientes servicios y recursos se encuentran disponibles para su uso.

Observe que hay dos servicios OData diferentes: una para acceder a los datos de negocio (recursos clasificados como parte de los servicios de data), y otra para acceder a la configuración de sistema relacionada con la definición de los Stakeholders (recursos clasificados como parte de los servicios de metadata), como se describe en el API de Bizagi.

 

URL Base

Observe que los siguiente servicios inician desde la URL base de su proyecto ([url_de_su_proyecto_de_bizagi]).

Considere:

[url_de_su_proyecto_de_bizagi]: Corresponde a la URL donde los usuarios finales tienen acceso al portal de trabajo de Bizagi.

Por ejemplo, en un proyecto on-premise, dicha URL sería:

https://[your_server]/[your_project]

Mientras que para los proyectos de Bizagi PaaS, sería:

https://[project_environment]-[your_project]-[your_company].bizagi.com

 

Servicios de Datos

Los servicios disponibles de Datos le permite acceder a los datos para uso general y para sus diferentes elementos: mis cosas (i.e, el recurso stuff), búsquedas, procesos relevantes (i.e, el recurso relevant), procesos y casos.

 

Uso General

Estos recursos manejas diferente información.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data

Lista todos los recursos de data (información estática).

Servicios de datos.

GET

/data/stakeholders

Lista los nombres de los Stakeholders configurados en su proyecto.

Datos de Stakeholder.

GET

/odata/data/userProfile

Obtiene la información relacionada con el usuario autenticado.

Perfil de Usuario.

GET

/odata/Image

Obtiene el detalle de una imagen (base 64).

URLs para imágenes y archivos.

GET

/odata/data/searchByCaseNumber(caseNumber='[id_case]')

Obtiene los detalles de un caso dado buscado por su número de caso.

Búsqueda de casos.

GET

/odata/data/queries

Lista todas las formas de consulta configuradas en su proyecto

Datos de consultas.

 

Mis cosas

Estos recursos inician a partir de la información obtenida para Mis Cosas de un Stakeholder.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/stuff

Lista todas las colecciones configuradas en mis cosas (que aplican a un Stakeholder, iniciando desde este recurso en adelante).

Mis cosas.

GET

/odata/data/stuff([id_stuff])

Obtiene la información de una colección configurada en mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/actions

Lista las acciones disponibles para una colección dada en mis cosas.

Datos de Acciones de Mis Cosas.

GET

/odata/data/stuff([id_stuff])/actions([id_action])

Obtiene información específica de una acción disponible en una colección en mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values

Obtiene todos los registros de una colección de mis cosas.

Mis cosas.

GET

/odata/data/stuff([id_stuff])/values([id_value])

Obtiene un registros de una colección de mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])/actions

Lista todas las acciones disponibles para un registro dado de una colección de mis cosas.

Datos de Acciones de Mis Cosas.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])

Obtiene la información específica de una acción dada disponible para un registro de una colección de mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities

Lista todos los atributos que son entidades relacionadas necesarias para lanzar una acción (de un registro de una colección en mis cosas).

Valores de entidades relacionadas.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])

Obtiene un atributo que es una entidad relacionada necesaria para lanzar una acción (de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])/values

Obtiene todos los posibles valores de un atributo dado que es una entidad relacionada necesaria para lanzar una acción (de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/relatedEntities([id_related])

/values([id_value])

Obtiene el valor de un atributo que es una entidad relacionada necesaria para ejecutar una acción (de un registro de una colección en mis cosas).

Mismo enlace anterior.

POST

/odata/data/stuff([id_stuff])/values([id_value])

/actions([id_action])/execute

Ejecuta una acción disponible para un registro dado de una colección en mis cosas.

Datos de Acciones Ejecutadas

GET

/odata/data/stuff([id_stuff])/values([id_value])/navigations

Busca otros atributos cuya información necesita ser detallada (de un registro de una colección en mis cosas).

Navegando hacia información enlazada

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda la información sobre un atributo dado en una entidad relacionada de un registro de una colección en mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo en una entidad relacionada de un registro de una colección en mis cosas.

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])/navigations

Busca otros atributos cuya información debe ser detallada (para un atributo de entidad relacionada para un registro dado de una colección en mis cosas para un atributo de entidad relacionada para un registro dado de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo de entidad relacionada para un registro dado de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda la información de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada para un registro dado de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada para un registro dado de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada dado, 2 dos niveles abajo, de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo de entidad relacionada dado, 2 dos niveles abajo, de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda la información de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada dado, 2 dos niveles abajo, de un registro de una colección en mis cosas).

Mismo enlace anterior.

GET

/odata/data/stuff([id_stuff])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])
/navigations([id_navigation])/values([id_value])

Obtiene la información específica sobre un atributo dado en una entidad relacionada (para un atributo de entidad relacionada dado, 2 dos niveles abajo, de un registro de una colección en mis cosas).

Mismo enlace anterior.

 

Búsquedas

Estos recursos acceden a las búsquedas y datos que se obtienen a través de las mismas, para un Stakeholder.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/searches

Lista todas las búsquedas (aplica para un Stakeholder, empezando desde este recurso en adelante).

Datos de las Búsquedas.

GET

/odata/data/searches([id_search])

Obtiene la información de una búsqueda dada.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/actions

Lista todas las acciones disponibles para una búsqueda dada.

Datos de acciones de resultados de búsquedas.

GET

/odata/data/searches([id_search])/actions([id_action])

Obtiene la información de una acción disponible para una búsqueda dada.

Mismo enlace anterior.

POST

/odata/data/searches([id_search])/performSearch

Ejecuta una búsqueda dada.

Ejecución de búsquedas.

GET

/odata/data/searches([id_search])/relatedEntities

Obtiene el conjunto de entidades que se especifican como parámetros de tipo entidad requeridos por el proceso para empezar un caso.

Valores de entidades relacionadas.

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])

Obtiene información adicional acerca de una entidad especifica requerida por un proceso dado como parámetro para empezar un caso .

Mismo enlace anterior.

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])/values

Obtiene el conjunto de valores posibles que puede tomar una entidad dada que es requerida como parámetro por un proceso específico para empezar un caso.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])

/relatedEntities([id_related])/values([id_value])

Obtiene información adicional acerca de un valor especifico de una entidad dada que es requerida como parámetro por un proceso para empezar un caso.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results

Obtiene los resultados de una búsqueda dada, la cual es ejecutada sin enviar parámetros.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

Obtiene un resultado específico de una búsqueda dada, la cual es ejecutada sin enviar parámetros.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/actions

Lista todas las acciones disponibles para un resultado dado de una búsqueda que se ejecuta sin enviar parámetros.

Datos de acciones de resultados de búsquedas.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])

Obtiene una acción disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros.

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities

Obtiene todos los posibles valores de un atributo dado que es una entidad relacionada necesaria para lanzar una acción (disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros).

Valores de entidades relacionadas.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])

Obtiene un atributo dado que es una entidad relacionada necesaria para lanzar una acción (disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])/values

Obtiene todos los posibles valores de un atributo dado que es una entidad relacionada necesaria para lanzar una acción (disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/relatedEntities([id_related])

/values([id_value])

Obtiene el valor específico de un atributo que es una entidad relacionada necesaria para lanzar una acción (disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

POST

/odata/data/searches([id_search])/results([id_result])

/actions([id_action])/execute

Ejecuta una acción (disponible para un resultado dado de una búsqueda ejecutada sin enviar parámetros).

Ejecución de búsquedas.

GET

odata/data/searches([id_search])/results([id_result])

/navigations

Busca otros atributos cuya información necesita ser detallada para un resultado dado de una búsqueda (que se ejecuta sin enviar parámetros).

Navegando hacia información enlazada

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])

Busca un atributo cuya información necesita ser detallada para un resultado dado de una búsqueda (que se ejecuta sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values

Obtiene toda la información de un atributo en una entidad relacionada para un resultado de una búsqueda (que se ejecuta sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo en una entidad relacionada para un resultado de una búsqueda (que se ejecuta sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Busca un atributo cuya información necesita ser detallada (para un atributo de entidad relacionada de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Busca otros atributos cuya información necesita ser detallada (Para un atributo de entidad relacionada, 2 niveles abajo, de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

[/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Buisca atributo dado cuya información necesita ser detallada (Para un atributo de entidad relacionada, 2 niveles abajo, de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (Para un atributo de entidad relacionada, 2 niveles abajo, de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

GET

/odata/data/searches([id_search])/results([id_result])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (Para un atributo de entidad relacionada, 2 niveles abajo, de un resultado que viene de una búsqueda ejecutada sin enviar parámetros).

Mismo enlace anterior.

 

 

Procesos relevantes

Estos recursos acceden a los procesos relevantes de un Stakeholder.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/relevants

Lista todos los procesos relevantes.

Relevante para Mí.

GET

/odata/data/relevants([id_relevant])

Obtiene la información de un proceso relevante.

Mismo enlace anterior.

POST

/odata/data/relevants([id_relevant])/start

Lanza un nuevo caso de un proceso relevante.

Inicio de procesos relevantes.

GET

/odata/data/relevants([id_relevant])/relatedEntities

Lista todos los atributos que son entidades relacionadas necesarias para lanzar un nuevo caso (de un proceso relevante dado).

Valores de entidades relacionadas

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])

Obtiene un atributo dado que es una entidad relacionada necesaria para lanzar un nuevo caso (de un proceso relevante dado).

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])/values

Obtiene todos los posibles valores de un atributo dado que es una entidad relacionada para lanzar un nuevo caso (de un proceso relevante dado).

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])

/relatedEntities([id_related])/values([id_value])

Obtiene un valor específico de un atributo dado que es una entidad relacionada para lanzar un nuevo caso (de un proceso relevante dado).

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])/actions

Lista todas las acciones disponibles para un proceso relevante.

Datos de acciones de resultados de búsquedas.

GET

/odata/data/relevants([id_relevant])/actions([id_action])

Obtiene la información de una acción disponible para un proceso relevante.

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities

Lista todos los atributos que son entidades relacionadas necesarias para lanzar una acción (de un proceso relevante dado).

Valores de entidades relacionadas

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])

Obtiene un atributo dado que es una entidad relacionada necesaria para lanzar una acción (de un proceso relevante dado).

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])/values

Obtiene todos los posibles valores de un atributo dado que es una entidad relacionada necesaria para lanzar una acción (de un proceso relevante dado).

Mismo enlace anterior.

GET

/odata/data/relevants([id_relevant])/actions([id_action])

/relatedEntities([id_related])/values([id_value])

Obtiene el valor de un atributo dado que es una entidad relacionada necesaria para ejecutar una acción (de un proceso relevante dado).

Mismo enlace anterior.

 

 

 

Procesos

Estos recursos acceden a procesos.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/processes

Lista todos los procesos (que aplican a un Stakeholder, empezando por esté recurso en adelante).

Datos de Proceso.

GET

/odata/data/processes([id_process])

Obtiene la información de un proceso dado.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/relatedEntities

Lista todos los atributos que son entidades relacionadas de un proceso dado (su forma de inicio).

Valores de entidades relacionadas

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])

Obtiene un atributo dado que es una entidad relacionada de dicho proceso (su forma de inicio).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])/values

Obtiene todos los posibles valores de una atributo dado que es una entidad relacionada de dicho proceso (su forma de inicio).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])

/relatedEntities([id_related])/values([id_value])

Obtiene un valor especifico de un atributo dado que es una entidad relacionada de un proceso dado (su forma de inicio).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/actions

Lista todas las acciones disponibles para un proceso dado.

Datos de acciones de resultados de búsquedas.

GET

/odata/data/processes([id_process])/actions([id_action])

Obtiene la información específica de una acción disponible para un proceso dado.

Mismo enlace anterior.

POST

/odata/data/processes([id_process])/start

Lanza un nuevo caso de un proceso dado.

Inicio de procesos.

GET

/odata/data/processes([id_process])/cases

Obtiene todos los caso pendientes de un proceso dado.

Datos de casos de procesos.

GET

/odata/data/processes([id_process])/cases([id_case])

Obtiene la información de un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/actions

Lista todas las acciones disponibles de un caso pendiente de un proceso.

Datos de acciones de resultados de búsquedas.

GET

/odata/data/processes([id_process])/cases([id_case])

/actions([id_action])

Obtiene la información una acción disponible de un caso pendiente de un proceso dado.

Mismo enlace anterior.

POST

/odata/data/processes([id_process])/cases([id_case])

/actions([id_action])/execute

Ejecuta una acción disponibles de un caso pendiente de un proceso dado.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems

Lista todos los workitems (actividades pendientes o eventos) de un caso pendiente de un proceso dado.

Datos de actividades de casos.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])

Obtiene la información de un workitem dado (actividad pendiente o evento) de un caso pendiente de un proceso dado.

Mismo enlace anterior.

POST

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/next

Ejecuta un workitem dado (actividad pendiente o evento) de un caso pendiente de un proceso dado.

Actividades desde completar procesos.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities

Lista todos atributos que son entidades relacionadas de un workitem dado (actividad pendiente o evento), para un caso pendiente de un proceso.

Valores de entidades relacionadas

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

Obtiene a atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

/values

Obtiene todos los posibles valores de un atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/workitems([id_workitem])/relatedEntities([id_related])

/values([id_value])

Obtiene un valor específico de una atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations

Busca otros atributos cuya información necesita ser detallada para un caso pendiente de un proceso.

Navegando hacia información enlazada

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada, para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada, para un caso pendiente de un proceso.

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo específico de entidad relacionada de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (para un atributo específico de entidad relacionada de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo específico de entidad relacionada de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada, 2 niveles abajo, de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo específico de entidad relacionada, 2 niveles abajo, de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (para un atributo específico de entidad relacionada, 2 niveles abajo, de un caso pendiente de un proceso).

Mismo enlace anterior.

GET

/odata/data/processes([id_process])/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo específico de entidad relacionada, 2 niveles abajo, de un caso pendiente de un proceso).

Mismo enlace anterior.

 

Casos

Estos recursos acceden a casos y sus actividades o eventos.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/cases

Lista todos los casos pendientes (aplica para cualquier usuario, empezando desde este recurso en adelante).

Casos desde el Portal de trabajo.

GET

/odata/data/cases([id_case])

Obtiene información para un caso pendiente dado.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/workitems

Lista todos los workitems (actividades pendientes o eventos) de un caso pendiente.

Actividades desde casos.

GET

/odata/data/cases([id_case])/workitems([id_workitem]

Obtiene la información de un workitem dado (actividad pendiente o evento) de un caso pendiente.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities

Lista todos los atributos que son entidades relacionadas de un workitem dado (actividad pendiente o evento), para un caso pendiente.

Valores de entidades relacionadas

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])

Obtiene un atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])/values

Obtiene toda possible values of a atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/workitems([id_workitem])

/relatedEntities([id_related])/values([id_value])

Obtiene un valor específico de un atributo que es una entidad relacionada de un workitem dado (actividad pendiente o evento), para un caso pendiente.

Mismo enlace anterior.

POST

/odata/data/cases([id_case])/workitems([id_workitem])/next

Ejecuta un workitem dado (actividad pendiente o evento) de un caso pendiente.

Actividades desde casos en el Portal de Trabajo.

GET

/odata/data/casesWithWorkitems

Lista todos los workitems (actividades pendientes o eventos), junto con la información de un caso pendiente.

Casos más actividades.

GET

/odata/data/cases([id_case])/navigations

Busca otros atributos cuya información necesita ser detallada para un caso pendiente.

Navegando hacia información enlazada

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values

Obtiene toda información de un atributo dado en una entidad relacionada, para un caso pendiente.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada, para un caso pendiente.

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo de entidad relacionada específico de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada específico de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada específico de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations

Busca otros atributos cuya información necesita ser detallada (para un atributo de entidad relacionada, 2 niveles abajo, de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

Busca un atributo dado cuya información necesita ser detallada (para un atributo de entidad relacionada específico, 2 niveles abajo, de un caso pendiente).

Mismo enlace anterior.

GET

/odata/data/cases([id_case])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])

/values([id_value])/navigations([id_navigation])/values

Obtiene toda información de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada específico, 2 niveles abajo, de un caso pendiente).

Mismo enlace anterior.

GET

[your_bizagi_project_url]/odata/data/cases([id_case])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

/navigations([id_navigation])/values([id_value])

Obtiene la información específica de un atributo dado en una entidad relacionada (para un atributo de entidad relacionada específico, 2 niveles abajo, de un caso pendiente).

Mismo enlace anterior.

 

Consultas

Estos recursos acceden a las Consultas configuradas en el proyecto, sus parámetros y permiten su ejecución remota.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/data/queries

Lista todas las consultas configuradas en el proyecto

Datos de consultas.

GET

/odata/data/queries([ID_query])

Obtiene información de la consulta en específico

Mismo enlace anterior.

GET

/odata/data/queries([ID_query])/parameters

Lista todos los parámetros disponibles para una consulta dada

Mismo enlace anterior.

GET

/odata/data/queries([ID_query])/parameters([ID_param])

Obtiene información del parámetro en específico de la consulta dada

Mismo enlace anterior.

GET

/odata/data/queries([ID_query])/parameters([ID_param])/values

Obtiene la lista de los posibles valores de un parámetro tipo entidad

Sin detalle.

GET

/odata/data/queries([ID_query])/parameters([ID_param])/values([ID_value])

Obtiene información adicional al respecto del valor especificado del parámetro

Sin detalle.

POST

/odata/data/queries([ID_query])/executeQuery

Ejecuta la consulta especificada usando los parámetros enviados en el cuerpo de la petición

Datos de consultas.

 

 

 

 

Servicios de Metadata

Los servicios disponibles de Metadata le permite acceder a la información de los Stakeholders configurados.

 

Método HTTP

URL

Descripción

Detalles adicionales

GET

/odata/metadata

Lista todos los recursos de metadata (información estática).

Servicios Metadata.

GET

/odata/metadata/getProject()

Obtiene la información del proyecto actual.

Descripción del Proyecto.

GET

/odata/metadata/processes

Lista todos los procesos disponibles

Descripción del proceso.

GET

/odata/metadata/processes([id_process])

Obtiene la información del proceso dado

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])/actions

Obtiene acciones del proceso asociadas a la entidad de proceso especificada

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process})

/actions([id_action])

Obtiene información adicional sobre una acción de proceso asociada con una entidad de proceso en específico

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])/navigations

Navega por otros atributos cuya información debe ser indagada

Navegar a información enlazada.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/processes([id_process])

/navigations([id_navigation])/navigations([id_navigation])/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders

Lista los Stakeholders disponibles.

Descripción del Stakeholders

GET

/odata/metadata/stakeholders([id_stakeholder])

Obtiene la información relacionada de un Stakeholder.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])/stuff

Lista todas las colecciones de mis cosas de un Stakeholder.

Descripción de Mis cosas.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])

Obtiene la información específica de una colección del Mis cosas de un Stakeholder.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/actions

Lista todas las acciones de una colección del Mis cosas para un Stakeholder.

 

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/actions([id_action])

Obtiene la información específica de una acción de una colección del mis cosas de un Stakeholder.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations

Navega por otros atributos cuya información debe ser indagada

Navegar a información enlazada.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/stuff([id_stuff])/navigations([id_navigation])

/navigations([id_navigation])/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches

Lista todas las búsquedas de un Stakeholder dado.

Descripción de las búsquedas.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])

Obtiene la información específica de una búsqueda de un Stakeholder dada.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/actions

Lista todas la acciones de una búsqueda de un Stakeholder dado.

 

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/actions([id_action])

Obtiene la información específica de una acción de una búsqueda de un Stakeholder dada.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations

Navega por otros atributos cuya información debe ser indagada

Navegar a información enlazada.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])/navigations

Navega por otros atributos cuya información debe ser indagada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/searches([id_search])/navigations([id_navigation])

/navigations([id_navigation])/navigations

/([id_navigation])

Trae detalles sobre la información enlazada especificada

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants

Lista todos los procesos relevantes para un Stakeholder dado.

Descripción de procesos relevantes.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])

Obtiene la información específica de un proceso relevante un Stakeholder dado.

Mismo enlace anterior.

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])/actions

Lista todas las acciones de un proceso relevante dado para un Stakeholder.

 

GET

/odata/metadata/stakeholders([id_stakeholder])

/relevants([id_relevant])/actions([id_action])

Obtiene la información específica de una acción de un proceso relevante de un Stakeholder dado.

Mismo enlace anterior.