getCaseDataUsingSchemaAsString

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

getCaseDataUsingSchemaAsString

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

 

note_pin

La descripción en este artículo aplica también para el método Web getCaseDataUsingSchema, el cual está disponible en la edición Bizagi .NET.

Para el método getCaseDataUsingSchema, el XML que se maneja en la solicitud (request) y en la respuesta (response) son del tipo XmlDocument (nativa de .NET).

Para el método getCaseDataUsingSchemaAsString la misma estructura de XMLs se maneja, sin embargo este parámetro es de tipo cadena (string).

 

 

note_pin

La siguiente definición aplica también para los métodos getCaseDataUsingSchemaLiteAsString o getCaseDataUsingSchemaLite.

La única diferencia con respecto a estos métodos, se basa en cómo Bizagi retorna la información de los adjuntos.

Con getCaseDataUsingSchemaAsString, Bizagi retorna los adjuntos de Bizagi como cadenas (string) en base 64 (si se incluyen estos atributos en el esquema).

Con getCaseDataUsingSchemaLiteAsString, Bizagi obteniene únicamente los nombres de los archivos.

 

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. Una forma sencilla de crear este esquema es usar la opción Xml Schemas para la entidad con la jerarquía mas alta en el modelo (e.g. la entidad de aplicación).

 

Para más información sobre la estructura esperada de los elementos dentro de Entities, consulte cómo se representan el modelo de datos del Proceso en Esquema XML de Bizagi para el modelo de datos .

 

 

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

La siguiente información considera el caso con identificador=752:

 

idCase = 752.

sxsd: <?xml version="1.0" encoding="utf-8"?><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="Numberofofficedaysrequeste" type="xs:integer" /></xs:sequence></xs:complexType></xs:element></xs:schema>

 

Nótese que el esquema que hemos especificado, inicia desde el atributo de la Entidad de Aplicación que referencia a la Entidad de Proceso (en nuestro ejemplo, se llama VacationRequest).

Para esta definición, el esquema corresponde a como se consulta para la Entidad de Aplicación en Bizagi Studio:

 

 

 

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;

getCaseDataUsingSchema_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 getCaseDataUsingXPathsAsString.