Unicat API Reference

Up - API Reference - Home


Define types of records with classes and fields.

Manage the available definitions for a project.


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

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

/api/p/<project gid>/definitions/fields/add add a custom field to a definition
/api/p/<project gid>/definitions/fields/move move a custom field inside a definition
/api/p/<project gid>/definitions/fields/remove remove a custom field from a definition

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

/api/p/<project gid>/definitions/fieldlists/fields/add add a field to a fieldlist
/api/p/<project gid>/definitions/fieldlists/fields/move move a field inside a fieldlist
/api/p/<project gid>/definitions/fieldlists/fields/remove remove a field from a fieldlist

/api/p/<project gid>/definitions/childdefinitions/add add a child definition to a definition
/api/p/<project gid>/definitions/childdefinitions/move move a child definition inside a definition
/api/p/<project gid>/definitions/childdefinitions/remove remove a child definition from a definition

/api/p/<project gid>/definitions/layouts/modify modify a definition's layout

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