Unicat API Reference

Up - API Reference - Home


Define types of records with classes and fields.

Manage the available classes for a project.


/api/p/<project gid>/classes/get get one or more classes
/api/p/<project gid>/classes/create create a class
/api/p/<project gid>/classes/modify modify a class
/api/p/<project gid>/classes/commit commit a class
/api/p/<project gid>/classes/revert revert a class
/api/p/<project gid>/classes/save_as_new save as a new class
/api/p/<project gid>/classes/copy copy a class
/api/p/<project gid>/classes/delete delete a class if it's not in use

/api/p/<project gid>/classes/fields/add add a field to a class
/api/p/<project gid>/classes/fields/move move a field inside a class
/api/p/<project gid>/classes/fields/remove remove a field from a class

/api/p/<project gid>/classes/metadata/set add or update a metadata field for a class
/api/p/<project gid>/classes/metadata/clear remove a metadata field from a class

/api/p/<project gid>/classes/layouts/modify modify a class' layout

/api/p/<project gid>/classes/layouts/components/create modify a class' layout by adding a new component
/api/p/<project gid>/classes/layouts/components/modify modify a class' layout by modifying a component
/api/p/<project gid>/classes/layouts/components/move modify a class' layout by moving a component
/api/p/<project gid>/classes/layouts/components/delete modify a class' layout by deleting a component