Unicat API Explained

Up - Home


Optimizing performance

When a project has many extended definitions, the initial schema data returned by /api/p/<project gid>/init, login, or auth can become large because every extended definition is included alongside the base schema. That can make UI startup take over 30 seconds. With omit_extended_definitions, startup stays quick regardless of project size.

Deferred loading of extended definitions

Use omit_extended_definitions on POST /api/p/<project gid>/init, login, or auth to exclude extended definitions from the initial project data.

All endpoints that return records include any referenced extended definitions. This is independent of whether omit_extended_definitions was used on init/login/auth.

Some endpoints also include additional extended definitions when relevant (for example, the worksheet endpoint includes extended definitions for sibling and child records).