Auswahlwerte
6 Endpunkte unter /api/rest/2.0
Properties (Merkmale) - options within a purpose
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 |
/purpose-properties |
List all purpose-propertys |
POST |
/purpose-properties |
Create a purpose-property |
GET |
/purpose-properties/{id} |
Get a purpose-property |
PUT |
/purpose-properties/{id} |
Update a purpose-property |
PATCH |
/purpose-properties/{id} |
Partially update a purpose-property |
DELETE |
/purpose-properties/{id} |
Delete a purpose-property |
Felder
Diese Felder liefert die API zu Auswahlwerte. 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 |
|---|---|---|
purpose_id |
integer | Associated purpose ID |
name |
string | Property name |
color |
string | Display color (hex, e.g. #FF0000) |
token |
string | Unique token identifier |
payload |
string | Additional payload data (JSON or text) |
sort |
integer | Sort order |
percent |
integer | Percent value (0-100) |
protected |
boolean | Whether property is protected from deletion |
searchable |
boolean | Whether property appears in search filters |
createable |
boolean | Whether property can be assigned to customers |
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.