From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS

<keywords content="keywords"> getEntitySchema, getentityschema, getEntitySchemaStr, getentityschemastr, get Entity Schema, get entity schema, SOA Layer, soa layer, EntityManagerSOA, entitymanagersoa, Entity Manager SOA, entity manager soa </keywords>

getEntitySchema

This method, from the EntityManagerSOA web service, returns the schema (XSD) of a Bizagi entity. This document also applies to the method getEntitySchemaStr.

Description

Providing the name of the entity to this method through its only parameter, of string type, Bizagi returns the XSD of the said entity. The XSD is given in XmlDocument format for this method, but in XML string format for its counterpart, getEntitySchemaStr.

Input Data

Parameter 1 (String Type)

entityName: Name of the entity for which the schema will be obtained.

Output Data

As mentioned previously, it will be the entity’s schema, describing each attribute (name, data type and occurrence). If an attribute has a relationship with another entity, then the first level of depth will also be included; that is to say, the attributes of that related entity will also be in the schema. But, if the related entity has relationships with other entities, these will not be included. The root element is always the entity’s name. Here is a response example of the Applicant entity.

Go to SOA Layer <comments />