getCategoriesLocalized

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

getCategoriesLocalized

Introducción

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

 

Este método recibe dos parámetros de entrada: el nombre de la Aplicación de negocio (sobre la cuál se van a obtener las categorías), y el idioma para el retorno de los nombres de estas categorías.

Esta información va cada una en un parámetro de tipo cadena (string).

 

A diferencia, del método getCategoriesAsString, la información de entrada NO es especificada con estructura XML.

 

Las categorías de negocio en una implementación de Bizagi son aquellas que se listan para una aplicación, desde el módulo de Procesos de Bizagi Studio:

 

 

getCategories

 

 

Datos de entrada

Los datos de entrada son 2 parámetros de tipo string.

 

Parámetros de entrada

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

language: Contiene el código del idioma con una cultura (por ejemplo pt-br o pt-pt), 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 envia la siguiente informacion:

application: Travel

language: en-us

 

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 Travel (Viajes) es la única de la aplicación Travel.

 

 

Métodos Web relacionados

Una vez que obtenga la lista de categorías de negocio, puede navegar hacia ellas y obtener la lista de los Procesos para una categoría en particular.

Para obtener esta lista, use los métodos getWorkflowClassesAsString o getWorkflowClasses.

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

 

También es factible que desee utilizar el método getApplications previamente, para obtener categories presented in this article.

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

 

Otra opción para obtener las categorías es utilizar los métodos getCategories o getCategoriesAsString. La diferencia, es que con estos otros métodos, se envia un único parámetro (en vez de los 2 de tipo cadena).

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