getCategoriesLocalized

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > SOAP web services > Available SOAP web services > WorkflowEngineSOA Web methods >

getCategoriesLocalized

Overview

This Web method is used to obtain the business categories in a Bizagi project (from an external application).

 

This method receives two input parameters: an Application name (that one from which we want to retrieve its child categories), and a language in which the categories' names will be obtained. This information is provided each in a separate input parameter of string-type.

 

Unlike the getCategoriesAsString Web method, this input information is NOT provided with XML structure.

 

Business categories in a project are those which can be seen through the Process Module in Bizagi Studio, for each project application:

 

getCategories

 

 

Input

Input for this Web method is sent as string text.

 

Input Parameters

application: Contains the name of the given application for which categories will be obtained.

language: Contains the language code and culture setting, to specify the localization in which the categories names will be returned.

If the sent value does not correspond to a valid Bizagi language code and culture (e.g es-es, en-gb, ru-ru), then categories name will be returned in the default language.

 

Input Example

For this method invocation, we may send the following input:

application: Travel

language: en-us

 

 

Output

 

Output Schema

The following shows a sample XML structure of information returned by Bizagi:

 

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

 

 

Output Parameters

categories: It is the root node; contains all categories for the given application.

category: Has the data for a particular category.

categoryId: This is the identification number (or key) for the category.

categoryName: Internal name of the category.

categoryDisplayName: Is the name the user sees.

categoryDescription: Description for the category.

categoryHelpText: Help text of the category.

categoryDisplayOrder: Order in which the category will be shown.

categoryCreationDate: The date when the category was created.

parentCategoryId: If this is a sub-category, the identification number (or key) of the parent category will go here, otherwise it will be 0 (zero).

 

 

Output Example

In the following example, we illustrate a returned XML-structured sample response from Bizagi SOA layer, in which we can see the returned output:

 

getCategoriesOutput

 

Notice that the Travel category is the only category available for the Travel application.

 

Related Web methods

Once you obtain the list of categories in your Bizagi project, you may want to drill down and obtain the Processes for a given category.

To obtain the Processes for a listed category, use the getWorkflowClassesAsString or getWorkflowClasses Web method.

For further information refer to the getWorkflowClassesAsString article.

 

It is likely that you may want to first use the getApplications Web method, in order to obtain the list of applications. The categories obtained with this method belong to a given application.

For further information, refer to the getApplications article.

 

Another option to obtain categories is to use the getCategories or getCategoriesAsString Web method. The difference in this other method, is that it will receive one string input with XML format. (instead of 2 string inputs).

For further information, refer to the getCategoriesAsString article.