Dateien
2 Endpunkte unter /api/rest/2.0
File attachments for entities
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 |
|---|---|---|
POST |
/files/{mod}/{mod_id} |
Upload a file |
DELETE |
/files/{mod}/{mod_id} |
Delete file(s) |
Felder
Diese Felder liefert die API zu Dateien. 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 |
|---|---|---|
file_id |
integer | Unique file identifier |
filename |
string | Original filename |
filesize |
integer | File size in bytes |
mediatype |
string | MIME type primary (e.g., image, application) |
subtype |
string | MIME type secondary (e.g., jpeg, pdf) |
add_dt |
date-time | Upload timestamp |
download_url |
uri | Signed download URL (valid for 24h) |
thumbnail_url |
uri | Signed thumbnail URL for images (valid for 24h) |
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.