A vocabulary is an admin-managed list of allowed values — for example a fixed set of document types. Bind a vocabulary to a custom metadata field and that field becomes a dropdown instead of a free-text box, so everyone tags documents with the same spelling and set of values instead of inventing their own.
A vocabulary is identified by a name (its namespace, e.g. doc-types) and
holds an ordered list of entries, each a single value (e.g. Invoice)
with an order. Vocabularies are consumed by custom metadata fields of type
VOCABULARY, which Teedy renders as a Select (dropdown) on the document form.
The metadata field types are:
| Type | Rendered as |
|---|---|
STRING |
Text box |
INTEGER |
Whole-number input |
FLOAT |
Decimal input |
DATE |
Date picker |
BOOLEAN |
Checkbox |
VOCABULARY |
Dropdown backed by a vocabulary |
Vocabularies are edited in Settings → Vocabulary (administrator only). Add a vocabulary name, then add ordered entries under it.
The vocabulary API uses application/x-www-form-urlencoded bodies:
| Action | Request |
|---|---|
| List entries | GET /api/vocabulary?name=<name> |
| Add an entry | PUT /api/vocabulary with form params name, value, order |
| Update an entry | POST /api/vocabulary/{id} |
| Delete an entry | DELETE /api/vocabulary/{id} |
| Check usage before rename/delete | GET /api/vocabulary/{id}/usage |
Before you rename or delete an entry, check how many documents already reference it. The usage endpoint returns that count, and the UI warns you with the number of documents affected so you do not silently orphan metadata on existing documents.
- In Settings → Vocabulary, create a vocabulary named
doc-types. - Add three ordered entries:
Invoice,Contract,Report. - In Settings → Metadata, create a custom metadata field named
Document Typeof typeVOCABULARY, bound to thedoc-typesvocabulary. - On any document, the
Document Typefield now shows a dropdown withInvoice/Contract/Reportinstead of a free-text box.