Konecty Meta Document
Manage document-type metadata definitions (fields, labels, events, indexes).
Prerequisites
Requires admin credentials from konecty-session. User must have admin: true.
API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/admin/meta/:document/document/:document | GET | Get full document meta |
/api/admin/meta/:document/document/:document | PUT | Upsert document meta |
Workflow
1. Show a document definition
python3 scripts/meta_document.py show Contact2. List fields
python3 scripts/meta_document.py fields Contact
python3 scripts/meta_document.py fields Contact --format json3. Add a field
python3 scripts/meta_document.py add-field Contact myNewField \
--type text --label-en "My Field" --label-pt "Meu Campo" --required4. Remove a field
python3 scripts/meta_document.py remove-field Contact myNewField5. Update a field property
python3 scripts/meta_document.py update-field Contact status --set isRequired=true
python3 scripts/meta_document.py update-field Contact status --set 'label.en=Status Name'6. Upsert full document
python3 scripts/meta_document.py upsert Contact --file document.json7. List document events
python3 scripts/meta_document.py events ContactKey concepts
fieldsis an object-map{"fieldName": {...}}, not an array- Field types: text, number, boolean, date, dateTime, picklist, lookup, email, phone, address, personName, money, file, composite, filter, richText, autoNumber, etc.
- See references/field-architecture.md for full field type documentation
- See references/document-events.md for queue/webhook event configuration
Script reference
See scripts/meta_document.py. Stdlib only.