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



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


This method does not receive input, and it will return all the business applications for the project. Business applications in a project are those which can be seen through the Process Module in Bizagi Studio:





This method does not receive any input information.





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="" xmlns:xs="" xmlns:xsd="" elementFormDefault="qualified" attributeFormDefault="unqualified">

 <xs:element name="applications">



                         <xs:element name="application" maxOccurs="unbounded">



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

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

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

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

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

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










Output Parameters

Applications: It is the root node; contains a child node "Application" for each application.

Application: Has the data for a particular application.

applicationId: This is the identification number (or key) for the application.

applicationName: Internal name of the application.

applicationDisplayName: Is the name the user sees.

applicationCreationDate: The date when the application was created.

applicationOrganizationId: This is the identification number of the organization to which the application belongs.



Output Example

In the following example, we illustrate a returned XML-structured sample response from Bizagi SOA layer, in which we see that the project only has the Credit application:





Related Web methods

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

To obtain the categories for a given application, use the getCategoriesAsString or getCategories Web method.

For further information refer to the getCategoriesAsString article.