WorkflowEngineSOA Web methods

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

Overview

Web methods published for WorkflowEngineSOA are useful to manage the processes workflow through Bizagi BPMN Engine (i.e., start Processes, advance Activities, trigger Events, abort Process instances, amongst others).

WorkflowEngineSOA is one of the three categories featuring web methods which are part of Bizagi API, as described at Available web services.

 

 

URL

This Web service and its methods, are found at the http URLs described below.

 

In Bizagi projects using Microsoft's IIS, Bizagi web services are located as:

http://[Server_name]/[Bizagi_project]/WebServices/WorkflowEngineSOA.asmx?wsdl

 

 

Web methods

The WorkflowEngineSOA web service offers the following methods:

 

abortCasesAsString: Cancels one or more cases given their case creation number in an XML in string format.

createCasesAsString: Creates one or more cases of a Bizagi Process. It is possible to create a blank case or also to include information the case needs. This method sends and receives a string XML.

getActivitiesAsString: Can be used to get all uncompleted Activities (pending, suspended or inactive). It sends and receives a string XML.

getApplications: Gets all available applications in Bizagi; it does not have input parameters.

getCategoriesAsString: Given the name of the application, returns the categories in it. Sends and receives an XML in string format.

getCategoriesFromApplicationName: Given the name of the application, returns the categories in it. This method sends a string and receives an XML in XmlDocument format.

getClosedActivitiesAsString: Obtains all completed Activities. The sent and received XML is in string XML format.

getEventsAsString: Returns all available Intermediate Events of a Process, using XMLs in string format.

getWorkflowClassesAsString: Obtains information about the Processes in a category. This method sends and receives a string XML.

getWorkflowClassesFromCategoryName: Given the name of the category, returns the Processes in it. This method sends a string and receives an XML in XmlDocument format.

perfomActivityAsString: This method is used to make a manual Activity to continue (as if the Next button was clicked). The parameters (input and output) for this method are of type string XML.

resumeCasesAsString: When a case or cases had been suspended, this method is used to resume them. Sends and receives an XML in string format.

saveActivityAsString: This method is used for available manual Activities to simulate the clicking of the Save button. Sends and receives a string XML.

setEventAsString: Use this method to trigger an available Intermediate Event, using XMLs in string format.

assignActivityAsString: Assigns/reassigns a case's Activity to a specific user. This method sends and receives a string XML.

 

 

note_pin

Additional web methods not explicitly listed above are deprecated and should not be used by new projects.

Such web methods are mainly shipped in Bizagi for backward compatibility purposes.