Introduction to Schema Builder API

Schema Builder allows you to prepare schemas for working with different kinds of data. You can also create relations between schemas to govern how records of different schemas are correlated. This can be used in combination with other features, such as automations, to create practically limitless opportunities.

The API also stores information that can be used to manage front-end display, used by the Synerise Portal. You can use the parameters to create your own GUI for schema management.

The articles in this section provide a step-by-step guide to working with the Schema Builder API.

Terms to know

Schemas

Schemas define a layout for data. That layout instructs what kind of data can be saved to a record and also how it should be displayed by a GUI. For example, a schema can be used to prepare a form where a person enters their personal details.

Records

A record is a single entry with data, according to a schema. If the schema is a form where a person enters their data, the record stores the data of one person.

Relations

Relations between schemas allow you to connect records from different schemas. For example, you can create a schema for storing projects and another for storing employees. Then, you can use relations to connect employee records with project records.

Tip: Relations are not mutually exclusive - at the same time, you can have a relation that allows each person to be assigned to only one project and another, where a person can belong to many projects.
An example use case for this is creating one relation to list project leaders (a person can only lead one project at a time) and another relation to store project stakeholders (a project leader can be involved in the workflows of many other projects).
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.