getCategoriesAsString

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

getCategoriesAsString

Overview

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

 

This method receives a single input having mainly: 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 in a single input parameter.

 

note_pin

The description provided in this article applies too for the a web method available in Bizagi .NET edition.

For the getCategories method, the request and response XML's are of the native .NET XmlDocument type.

For the getCategoriesAsString method the same XML structure is handled, but this parameter is sent as a string type.

 

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 Schema

The following shows a sample XML structure of information to send to Bizagi:

 

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

 

 

Input Parameters

BizAgiWSParam: Root node.

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 by default in English language.

 

Input Example

With the following example, we will retrieve categories under the Travel application.

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

<BizAgiWSParam>

 <application>Travel</application>

 <language>en-us</language>

</BizAgiWSParam>

 

 

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

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

For further information refer to the getWorkflowClassesAsString article.

 

It is likely that you may want to use the getApplications Web method prior to using the Web methods to obtain categories presented in this article.

For further information, refer to the getApplications article.

 

Another option to obtain categories is to use the getCategoriesLocalized Web method. The difference in this other method, is that it will receive 2 string inputs, instead of a single XML-formed string.

For further information, refer to the getCategoriesLocalized article.