Introducción
Este método se utiliza para obtener un XSD (esquema de XML) que define una Entidad en Bizagi (desde una aplicación externa).
Este método recibe un único parámetro de entrada que es de tipo cadena (string). En este se especifica el nombre de la Entidad de la cuál se obtiene la definición del esquema.
Este método es útil para posteriormente invocar otros métodos como getCaseDataUsingSchemaAsString o getEntitiesUsingSchemaAsString, donde se envia un esquema como dato de entrada.
Para más información sobre estos métodos, consulte la sección al final de este artículo.
•Para el método getEntitySchema, los XMLs de petición y de respuesta son de tipo XmlDocument nativo de .NET.
•Para el método getEntitySchemaStr 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
Los datos de entrada se envían de tipo cadena (string).
Esquema y Parámetros de entrada
•entityName: Contiene el nombre de la Entidad de la cual vamos a obtener el XSD (esquema de XML).
Ejemplo de entrada
Con el siguiente ejemplo, se envia:
•entityName: Hotel
Para este ejemplo, tanto para el método getEntitySchema como para el método getEntitySchemaStr la entrada puede ser la misma:
<EntityName>Applicant</EntityName>
Le recomendamos utilizar Cómo iniciar Procesos en Bizagi desde otras aplicaciones como guía para invocar este servicio.
Datos de salida
Esquema y Parámetros de salida
La estructura del XML que retorna Bizagi corresponde a 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 de salida
Con el siguiente ejemplo, se ilustra la respuesta que retorna la invocación de este método en Bizagi, en donde vemos la definición de esquema para la Entidad Hotel:
Una vez que se obtenga la definición del esquema de una Entidad del modelo de datos, puede optar por utilizar otros métodos para obtener la información de esa Entidad de acuerdo al esquema.
Para ello, use el esquema como filtro.
Para más información sobre consultar información de negocio para un caso, consulte getCaseDataUsingSchemaAsString.
Para más información sobre consultar los registros de una Entidad, consulte getEntitiesUsingSchemaAsString.