Wertelisten
11 Endpunkte unter /api/rest/2.0
Purposes (Verwendungszwecke) - groups of properties
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 |
/purposes |
List all purposes |
POST |
/purposes |
Create a purpose |
POST |
/purposes/blueprint |
Import a purpose from a blueprint |
GET |
/purposes/blueprint/schema |
Get the purpose blueprint JSON Schema |
GET |
/purposes/{id} |
Get a purpose |
PUT |
/purposes/{id} |
Update a purpose |
PATCH |
/purposes/{id} |
Partially update a purpose |
DELETE |
/purposes/{id} |
Delete a purpose |
GET |
/purposes/{id}/blueprint |
Export a purpose as a blueprint |
POST |
/purposes/{id}/blueprint |
Update a purpose from a blueprint |
GET |
/purposes/{id}/properties |
List properties of a purpose |
Felder
Diese Felder liefert die API zu Wertelisten. 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 |
|---|---|---|
name |
string | Purpose name |
notice |
string | Description/notice |
token |
string | Unique token identifier |
protected |
boolean | Whether purpose is protected from deletion |
use_percent |
boolean | Whether properties show percent values |
use_conversion_value |
boolean | Whether properties use conversion values |
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.