Getting an Object Schema using the Model Class in a Creatio Freedom UI Page

In this first article on using the Model class I’ll be showing how to get the schema of an object. The model class in the DevKit SDK is the new API for working with entity data in Freedom UI pages. Previously in classic Creatio pages, you’d create EntitySchemaQuery objects to query data, InsertQuery to create new records, UpdateQuery to update records, or DeleteQuery to delete data. All of this is now replaced with the Model class in Freedom UI pages. The Model class is available via the new Creatio DevKit SDK.

To use the devkit, you’ll need to add “@creatio-devkit/common” to the modules list of your page. This will look like this (note the “@creatio-devkit/common” in the square brackets and the sdk without quotes in the parenthesis):

define("UsrMyCustomEntity_FormPage", /**SCHEMA_DEPS*/["@creatio-devkit/common"] /**SCHEMA_DEPS*/, 
function/**SCHEMA_ARGS*/(sdk)/**SCHEMA_ARGS*/ {
	return {
		// ... the rest of the page here

Now, with that module available, you can access things in the SDK, such as the Model class. In this article our focus will be to retrieve an entity/object schema, including the title, primary display property and the list of all columns/properties for the object.

As an example, we’ll be retrieving the schema for the Account object. The code is simple and will look as follows:

const account = await sdk.Model.create("Account");
const accountSchema = await account.getSchema();

So what does that look like? For the Account object, if I dumped that out to the console it would look as follows:

I’ve not expanded all the properties in that screenshot because there is really a lot of info provided. Not only do you get the column names and captions, you also get default values, if it’s required, it it copies with new records, and even validators.

Here’s what the Owner column looks like, notice the default values:

Here’s the GPS E field, that has a max length validator:

It certainly is more simple that the previous methods for retrieving the schema info for objects.

Want content like this delivered to your inbox? Sign up for our newsletter!

Ryan Farley

Ryan Farley is the Director of Development for Customer FX and creator of He's been blogging regularly about SalesLogix, now Infor CRM, since 2001 and believes in sharing with the community. His new passion for CRM is Creatio, formerly bpm'online. He loves C#, Javascript, web development, open source, and Linux. He also loves his hobby as an amateur filmmaker.

Submit a Comment

Your email address will not be published. Required fields are marked *