Bizagi OData API Custom framework

descripción

Son unos servicios REST que permiten a sistemas externos interactuar con bizagi

motivación

  • Crear una API - Rubik: Orientada más al negocio
  • REST en lugar de SOA: Seguridad más simple y usada (oAuth2), JSONs (más livianos que XML)
  • OData: Los servicios son OData compliant. OData es un protocolo que ofrece una metadata que describe al servicio REST, lo cual permite a los clientes que lo soporten, integrarse con bizagi sin implementaciones adicionales (similar a SOAP pero más flexible).

¿custom framework? ¿cómo así?

La aproximación inicial fue usar el framework que ofrecía .NET. Pero el código quedó muy complejo, extenso y en consecuencia de difícil mantenimiento, por lo que Diego Parra desarrolló un framework que se ajusta a nuestras necesidades y se reimplementaron los servicios usando este.

nuestro primer consumidor

Bizagi Sites

metadata

GET odata/metadata

GET odata/metadata/stakeholders

GET odata/metadata/stakeholders(id)

GET odata/metadata/stakeholders(ID)/stuff

GET odata/metadata/stakeholders(ID)/stuff(ID)

GET odata/metadata/stakeholders(ID)/searches

GET odata/metadata/stakeholders(ID)/searches(ID)

  • Trae un search en particular de la colección de searches

GET odata/metadata/stakeholders(ID)/relevants

GET odata/metadata/stakeholders(ID)/relevants(ID)

  • Trae un relevant en particular de la colección de relevants

GET odata/metadata/processes

GET odata/metadata/processes(ID)

  • Trae un proceso particular de la colección de processes

GET odata/metadata/getProject()

data

La medatata y data que retornan estos servicios están dentro de los contextos definidos para el usuario autenticado

GET odata/data

GET odata/data/stuff

GET odata/data/stuff(ID)

  • Trae la metadata del stuff específico

GET odata/data/stuff(ID)/values

GET odata/data/stuff(ID)/values(ID)

  • Trae los datos de la entidad especificada

GET odata/data/stuff(ID)/values(ID)/actions

GET odata/data/stuff(ID)/values(ID)/actions(ID)

  • Trae la acción especificada de la colección de acciones

POST odata/data/stuff(ID)/values(ID)/actions(ID)/execute

  • request
  • response

GET odata/data/searches

GET odata/data/searches(ID)

  • Retorna el Search especificado

POST odata/data/searches(ID)/performSearch

  • request
  • response

GET odata/data/searches(ID)/results

  • Realiza una búsqueda sin parámetros retornando una colección de entidades similar a la de la función performSearch

GET odata/data/searches(ID)/results(ID)

  • Retorna la entidad especifica del resultado de results

GET odata/data/searches(ID)/results(ID)/actions

  • Retorna la metadata de las acciones asociadas a la entidad especificada igual que cuando se consultan por stuff

GET odata/data/searches(ID)/results(ID)/actions(ID)

  • Retorna la acción especificada

POST odata/data/searches(ID)/results(ID)/actions(ID)/execute

  • Ejecuta la acción especificada de forma similar a como se hace para stuff

GET odata/data/relevants

  • Retorna la metadata de los relevants. Similar a odata/metadata pero contextualizado para el usuario autenticado

GET odata/data/relevants(ID)

  • Retorna la metadata del relevant especificado

POST odata/data/relevants(ID)/start

  • Inicia un caso del proceso relevante para el usuario. El request y el response son similares a los de las acciones

GET odata/data/processes

  • Retorna la metadata de todos los procesos. La estructura de datos es la misma que relevants.

GET odata/data/processes(ID)

  • Retorna la metadata del proceso especificado

GET odata/data/processes(ID)/cases

GET odata/data/stakeholders

GET odata/data/userProfile

Credits:

Created with images by stux - "fog outlines pine" • valiunic - "green park season" • stux - "fog outlines pine" • Hemlit - "Landscape"

Made with Adobe Slate

Make your words and images move.

Get Slate

Report Abuse

If you feel that this video content violates the Adobe Terms of Use, you may report this content by filling out this quick form.

To report a Copyright Violation, please follow Section 17 in the Terms of Use.