EntityManagerSOA Web methods

<< Click to Display Table of Contents >>

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

EntityManagerSOA Web methods

Overview

Web methods published for EntityManagerSOA are useful to access the Processes data model (i.e to obtain or update business information related to existing cases, get, insert or update lists of values in Bizagi parameter Entities, amongst others).

EntityManagerSOA 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/EntityManagerSOA.asmx?wsdl

 

Web methods

The EntityManagerSOA web service offers the following methods:

 

getCaseDataUsingSchemaAsString: Gets all the case data having, as parameters, the idCase and an XSD in string XML format.

getCaseDataUsingSchemaLiteAsString: Gets all the case data having, as parameters, the idCase and an XSD in string XML format. The response to this method will not include the content of file attributes.

getCaseDataUsingXPathsAsString: Gets all the case data having, as parameters, a string XML with the desired Xpaths in Bizagi.

getEntitiesAsString: Obtains data from an entity in string XML format.

getEntitiesUsingSchemaAsString: Obtains data from an entity (or entities), specifying the required data in an XSD, in string XML format.

getEntitySchemaStr: Using the entity's name as parameter, extracts its schema in an XML string.

saveEntityAsString: Is used to save and update data in Bizagi using an string XML.

saveEntityWithKeyAsString: Used to update an entity having, as parameters, an XML in string format with the data and the key for the entity.

 

 

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.