Zusatzfelder
8 Endpunkte unter /api/rest/2.0
Custom fields (Zusatzfelder) for various modules
Endpunkte
Alle Pfade sind relativ zur Basis /api/rest/2.0 Ihrer ameax-Installation. Die Antworten folgen dem JSON:API-Format mit data, links und meta.
| Methode | Pfad | Beschreibung |
|---|---|---|
GET |
/fields |
List field modules |
GET |
/fields/{modtoken} |
List all fields |
POST |
/fields/{modtoken} |
Create a field |
GET |
/fields/{modtoken}/types |
List available field types |
GET |
/fields/{modtoken}/{id} |
Get a field |
PUT |
/fields/{modtoken}/{id} |
Update a field |
PATCH |
/fields/{modtoken}/{id} |
Partially update a field |
DELETE |
/fields/{modtoken}/{id} |
Delete a field |
Felder
Diese Felder liefert die API zu Zusatzfelder. Dazu kommen die Zusatzfelder Ihrer eigenen Installation — sie werden nach denselben Regeln geprüft wie in der Oberfläche und erscheinen in der Spezifikation Ihres Mandanten.
| Feld | Typ | Beschreibung |
|---|---|---|
modtoken |
string | Module token |
field |
string | Internal field name |
label |
string | Display label |
type |
string | Field type (see GET /fields/{modtoken}/types) |
subtype |
string | Field subtype |
description |
string | Field description/tooltip (plain text) |
explainer |
string | Extended description (HTML) |
required |
boolean | Whether field is required |
sys |
boolean | System field flag |
protection |
boolean | Protection flag |
purposeId |
integer | Purpose/Tree ID for dropdown/hierarchy fields |
options |
string | Options for dropdown/radio fields |
preset |
string | Default value preset |
isFormula |
boolean | Whether field is a formula |
formula |
string | Formula expression |
sortOrder |
integer | Sort order |
dependsFieldId |
integer | Dependent field ID |
dependsValues |
string | Values for dependency |
Zugriff
Jede Anfrage braucht ein API-Token im Kopf Authorization: Bearer <token>, wahlweise als Basic-Auth mit dem Benutzernamen api und dem Token als Passwort.
Das Token hängt an einem Benutzer und erbt dessen Rechte: Was dieser Benutzer in der Oberfläche nicht sehen darf, liefert die API auch nicht. Zusätzlich lassen sich je Token ein Ablaufdatum und eine IP-Beschränkung hinterlegen. Mehr dazu auf der API-Übersicht.
Anbindung besprechen.
Sie wollen ein System anbinden und wissen nicht, ob die Schnittstelle abdeckt, was Sie brauchen? Wir schauen es uns gemeinsam an — kostenlos und ohne Verpflichtung.