Notizen
6 Endpunkte unter /api/rest/2.0
Notes/notices for customers
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 |
/notices |
List all notices |
POST |
/notices |
Create a notice |
GET |
/notices/{id} |
Get a notice |
PUT |
/notices/{id} |
Update a notice |
PATCH |
/notices/{id} |
Partially update a notice |
DELETE |
/notices/{id} |
Delete a notice |
Felder
Diese Felder liefert die API zu Notizen. 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 |
|---|---|---|
customer_id |
integer | Associated customer ID |
subject |
string | Notice subject/title |
notice |
string | Notice content/body |
precedence |
integer | Display precedence (higher = more prominent) |
external_id |
integer | External import ID |
created_at |
date-time | Creation timestamp |
created_by |
integer | ID of user who created the notice |
updated_at |
date-time | Last modification timestamp |
updated_by |
integer | ID of user who last modified the notice |
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.