Datentyp: Medienhilfe-Datei
Beschreibung:
Wenn du Medien in TYRIOS nutzen willst, musst du sie in das Mediensystem hochladen. Das hat mehrere Gründe:
- Die Medien im Mediensystem werden automatisch analysiert und optimiert. Das bedeutet vor allem für Bilder und Videos, dass die Dateien automatisch in Bezug auf Abmessungen, Größe und Qualität optimiert werden.
- Medien werden automatisch gesäubert. Dazu gehört nicht nur eine Mime- und Inhaltsanalyse, sondern auch eine automatische Virenprüfung.
Medien im Mediensystem werden als MediahelperFile-Objekt verwaltet. Auf dieser Seite wird die allgemeine Struktur dieses Objekts beschrieben.
Achtung
Bitte beachte: TYRIOS ist ein aspektorientiertes System und die konkrete Datenstruktur hängt von deiner Systemkonfiguration ab. Vor allem, wenn du bestehende Daten aktualisieren willst, solltest du alle verfügbaren Felder berücksichtigen oder einen aktualisierungsspezifischen API-Endpunkt verwenden, um Datenverluste zu vermeiden.
Allgemeine Datenstruktur
Im Allgemeinen hat ein MediahelperFile-Objekt die folgende Datenstruktur:
{
"id": 120, // automatisch zugewiesene ID
"fileName": "coupon.jpg", // Basisname der Datei
"mediaType": "1", // Medientyp, 1=Bild, 2=Video, 3=Ton, 4=Dokument, 5=Zip, 6=Verzeichnis
"detailFormat": "JPEG", // Bei Bildern: JPEG, PNG, GIF oder SVG
"filePath": "/directory/", // relativer Pfad zum MEDIA-Hauptsystem
"alternativeText": null, // standardmäßiger Alternativtext
"fileDescription": null, // Dateibeschreibung
"uploadTime": 1487531110, // Unix-Zeitstempel des Uploads
"MediahelperFileDescendant": null, // Referenz auf abgeleitete Dateien
"parentID": 1, // ID der übergeordneten Datei
"UserData": 1, // ID des hochladenden Benutzers
"securityLevel": "1", // 1=öffentlich, 2=freigegeben via fileHash, 3=privat
"fileHash": null, // Hash für Sicherheitslevel 2/3
"diskFileHash": "f6d725052b81cc737af2e06c2e53fa897233e765", // SHA1-Hash der Datei
"version": 7, // Versionsnummer
"width": 1200, // Bildbreite
"height": 392, // Bildhöhe
"source": null, // Herkunft der Medien
"license": null, // Lizenzinformation
"copyrightInformation": null // Copyright-Text
}
Normalerweise gibt es in deiner Instanz zusätzlich viele Verweise, um sicherzustellen, dass ein Medium nicht gelöscht werden kann, während es benutzt wird. Je nach API können diese Referenzen geladen und bereitgestellt werden. Außerdem stellt das System normalerweise automatisch Vorschau- und Download-URLs über JSON bereit.