getCategoriesAsString

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

getCategoriesAsString

Introducción

Este método se utiliza para obtener las categorías de negocio de las aplicaciones de una implementación de Bizagi (desde una aplicación externa).

 

Este método recibe un único parámetro de entrada el cual contiene principalmente: el nombre de la aplicación de negocio de la cual se quieren obtener las categorías, y el lenguage deseado.

 

Las categorías que retorna Bizagi son las que se listan y se pueden consultar desde el módulo de Procesos, desde Bizagi Studio:

 

 

getCategories

 

 

note_pin

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

Para el método getCategories, 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 getCategoriesAsString la misma estructura de XMLs se maneja, sin embargo este parámetro es de tipo cadena (string).

 

Datos de entrada

 

Esquema de entrada

La estructura del XML que se envia a Bizagi debe ser cumplir con este XSD:

<?xml version="1.0" encoding="utf-8"?>

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

 <xs:element name="BizAgiWSParam">

         <xs:complexType>

                 <xs:sequence>

                         <xs:element name="application" type="xs:string"/>

                         <xs:element name="language" type="xs:string"/>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

Parámetros de entrada

BizAgiWSParam: Nodo raíz.

application: Contiene el nombre de la aplicación deseada (escriba el nombre, no el nombre a mostrar).

language: Contiene el código del idioma en el que se desea que sean retornadas las categorias. En caso de enviarse un código de idioma no registrado en Bizagi, este retornará los valores en el idioma por defecto.

 

 

Ejemplo

Con el siguiente ejemplo, se obtienen las categorias de la apliación de Viajes (Travel):

<?xml version="1.0" encoding="utf-8"?>

<BizAgiWSParam>

 <application>Travel</application>

 <language>en-us</language>

</BizAgiWSParam>

 

Datos de salida

 

Esquema de salida

La estructura del XML que se retorna en Bizagi cumple con este XSD:

<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

 <xs:element name="categories">

         <xs:complexType>

                 <xs:sequence>

                         <xs:element name="category">

                                 <xs:complexType>

                                         <xs:sequence>

                                                 <xs:element name="categoryId" type="xs:unsignedByte"/>

                                                 <xs:element name="categoryName" type="xs:string"/>

                                                 <xs:element name="categoryDisplayName" type="xs:string"/>

                                                 <xs:element name="categoryDescription"/>

                                                 <xs:element name="categoryHelpText"/>

                                                 <xs:element name="categoryDisplayOrder" type="xs:unsignedByte"/>

                                                 <xs:element name="categoryCreationDate" type="xs:dateTime"/>

                                                 <xs:element name="parentCategoryId" type="xs:unsignedByte"/>

                                         </xs:sequence>

                                 </xs:complexType>

                         </xs:element>

                 </xs:sequence>

         </xs:complexType>

 </xs:element>

</xs:schema>

 

 

Parámetros de salida

categories: Es el nodo raíz; contiene todas las categorías de la aplicación dada.

category: Contiene toda la información de una categoría específica.

categoryId: Este es el número de identificación (o llave) para la categoría.

categoryName: Nombre interno de la categoría.

categoryDisplayName: Es el nombre que el usuario ve.

categoryDescription: Descripción de la categoría.

categoryHelpText: Texto de ayuda de la categoría.

categoryDisplayOrder: Orden en el cual se muestra la categoría.

categoryCreationDate: Fecha de creación de la categoría.

parentCategoryId: Si se trata de una sub categoría, este elemento contendrá el número de identificación (o llave) de la categoría padre, de lo contrario, contendrá un 0 (cero).

 

 

Ejemplo

Con el siguiente ejemplo, se ilustra la respuesta que retorna la invocación de este método en Bizagi.

 

getCategoriesOutput

 

Nótese que la categoría llamada Travel es la única que figura dentro de la aplicación Travel.

 

 

Métodos Web relacionados

 

Para más información sobre esta opción, consulte