Obtener Datos del Caso Utilizando Esquemas Ligero

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi desde aplicaciones externas > API de Bizagi para aplicaciones externas > Servicios web disponibles > Métodos Web de EntityManagerSOA >

Obtener Datos del Caso Utilizando Esquemas Ligero

Introducción

Este método se utiliza para obtener tanto información de negocio, como detalle general (por ejemplo, fecha de creación, fecha estimada de solución, etc) para un caso en Bizagi (desde una aplicación externa).

 

Este método recibe 3 parámetros de entrada, de los cuales 2 de ellos son estrictamente requeridos: el identificador del caso, y un XSD (esquema de XML) para especificar qué información de negocio se quiere obtener.

El parámetro opcional es especificar el work-item (instancia de Actividad para un caso) para indicar si Bizagi debe obtener la información de una Actividad en particular (que no esté persistida necesariamente en la Base de datos pero que esté en el scope).

 

Para el método getCaseDataUsingSchemaLite, los XMLs de petición y de respuesta son de tipo XmlDocument nativo de .NET.

Para el método getCaseDataUsingSchemaLiteAsString se maneja la misma estructura XML pero los parámetros son enviados como un tipo cadena de texto por medio de CDATA.

 

 

Datos de entrada

 

Esquema y Parámetros de entrada

idCase: Corresponde al número de identificación interno (id en la base de datos) del caso en Bizagi.

idWorkitem: (Opcional). Corresponde al identificador de la instancia de una tarea. Con dicho parámetro se puede obtener los datos de un caso que estén almacenados en una actividad, sin que necesariamente esa actividad haya avanzado y persistido los datos.

xsd: Esquema con la información que será extraída. La estructura del esquema enviado debe corresponder a la obtenida desde la definición de la Entidad de Proceso. Para el método getCaseDataUsingSchemaLiteAsString este parámetro se llama sxsd. la estructura del esquema debe estar encerrada como CDATA.

Para más información sobre la estructura esperada, consulte Esquema XML de Bizagi para el modelo de datos.

Dentro de este XSD, el atributo nillable funciona para buscar la información de un caso a través de un XSD.

 

Ejemplo

Con el siguiente ejemplo, se obtienen el número de dias solicitados para vacaciones (Number of Office Days requested), en un Proceso de solicitud de Vacaciones (Vacation Request).

Observe que el esquema especificado iniciará desde la Entidad de Aplicación, la cual hace referencia a la entidad de proceso (llamada VacationRequest en nuestro ejemplo). Para esta definición, el esquema corresponde al obtenido desde la Entidad de aplicación de nuestro ejemplo.

Haremos esto para una instancia de proceso con número de caso 51 y por lo tanto, para cada entrada enviamos:

 

Método getCaseDataUsingSchemaLite

<idCase>51</idCase>
<idWorkItem />
<xsd>
  <xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="VacationRequest">
        <xs:complexType>
          <xs:sequence>
              <xs:element minOccurs="0" maxOccurs="1" name="NumberOfOfficeDaysReques" type="xs:integer" />
          </xs:sequence>
        </xs:complexType>
    </xs:element>
  </xs:schema>
</xsd>

 

Método getCaseDataUsingSchemaLiteAsString

<idCase>51</idCase>

<idWorkItem />

<sxsd>

 <![CDATA[<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

         <xs:element name="VacationRequest">

                 <xs:complexType>

                         <xs:sequence>

                                 <xs:element minOccurs="0" maxOccurs="1" name="NumberOfOfficeDaysReques" type="xs:integer" />

                         </xs:sequence>

                 </xs:complexType>

         </xs:element>

 </xs:schema>]]>

</sxsd>

 

Datos de salida

 

Esquema y Parámetros de salida

La información retornada en formato XML contiene el nodo raíz BizAgiWSResponse, y sus elementos internos corresponden a lo definido en el esquema (del dato de entrada).

 

Ejemplo

Con el siguiente ejemplo, se ilustra la respuesta que retorna la invocación de este método en Bizagi, podemos ver que un caso específico es retronado de acuerdo al esquema especificado.

Le recomendamos utilizar Cómo iniciar Procesos en Bizagi desde otras aplicaciones como guía para invocar este servicio.

 

Método getCaseDataUsingSchemaLite

 

getCaseDataUsingSchema_sampleOutput

 

Método getCaseDataUsingSchemaLiteAsString

 

getCaseDataUsingSchemaLiteAsString_sampleOutput

 

Métodos Web relacionados

 

Si desea utilizar definiciones de Xpath en vez de un XSD como filtro de la información a obtener, use los métodos getCaseDataUsingXPathsAsString o getCaseDataUsingXPaths.

Para más información sobre esta opción, consulte Obtener Datos del Caso utilizando XPaths.