EntityManagerSOA Web methods

<< Click to Display Table of Contents >>

Navigation:  Low-code Process Automation > Studio Cloud - Authoring environment > Bizagi Studio > Bizagi from external applications > Bizagi API > Alternative SOAP 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.

 

note_pin

To consult file attributes, refer to the methods get Case Data Using XPaths and get Case Data Using Schema. Take into account that both methods only retrieve data from open cases and activities.

 

URL

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

WS-Security web services when enabled, are located as:

https://[environment]-[project]-[company].bizagi.com/WebServices/[internal_component].svc?wsdl

 

Web methods

The EntityManagerSOA web service offers the following methods:

 

Method

Description

Invocation

Create User

Creates users in Bizagi from external applications

CreateUser

CreateUserAsString

Get Case Data Using Schema

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

getCaseDataUsingSchema

getCaseDataUsingSchemaAsString

Get Case Data Using Schema Lite

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.

getCaseDataUsingSchemaLite

getCaseDataUsingSchemaLiteAsString

Get Case Data Using XPaths

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

getCaseDataUsingXPaths

getCaseDataUsingXPathsAsString

Get Entities

Obtains data from an entity in string XML format.

getEntities

getEntitiesAsString

Get Entities Using Schema

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

getEntitiesUsingSchema

getEntitiesUsingSchemaAsString

Get Entity Schema

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

getEntitySchema

getEntitySchemaStr

Save Entity

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

saveEntity

saveEntityAsString

 

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.

Localization is not available for these methods.

 


Last Updated 2/4/2022 12:05:46 PM