GetCategories
De
<keywords content="keywords"> getCategories, getCategories AsString, get Categories, SOA Layer, WorkflowEngineSOA, Workflow Engine SOA </keywords>
Contenido |
getCategories
Método del servicio web WorkflowEngineSOA utilizado para consultar las categorías en una aplicación de un proyecto Bizagi. Este artículo aplica también para el método getCategoriesAsString.
Descripción
Con este método es posible obtener información acerca de las categorías que pertenecen a la aplicación que se especifica en el parámetro de entrada. Para los métodos getCategories y getCategoriesAsString, el parámetro que se envía es un XML con el nombre de la aplicación que contiene las categorías deseadas; el primer método recibe un XmlDocument mientras que el segundo recibe un string.
Parámetros de Entrada
Este es el esquema del XML esperado (puede copiarlo directamente de aqui):
Parámetro 1 (XmlDocument o Tipo String)
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
Este será el XML utilizado para obtener todas las categorías de la aplicación de Crédito (en inglés, Credit).
Parámetros de Salida
Este es el esquema del XML de respuesta:
A continuación se explíca la información incluída en el XML de respuesta.
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
Aquí encontrará un ejemplo de la respuesta para este método:
Artículos Relacionados
<comments />
