file_storage/get_overview.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe

Abrufen der aktuellen Ordnerstruktur aus der Dateiablage inklusive der Dateien und UUIDs zur Referenz für die modifiy_file.php oder um die Datei per do_order bzw. do_message zu nutzen. Außerdem wird die aktuelle Auslastung mit angegeben.

Beschreibung

GET /file_storage/get_overview.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja

Rückgabe

Die Rückgabe erfolgt im JSON-Format. Bei fehlenden Pflichtparametern wird ein "ERROR:Beschreibung" zurückgegeben.

Rückgabebeispiel
Rückgabe als JSON
{
"total_space": ?,
"used_space": ?,
"structure": {
     "name": "Meine Ablage",
     "subfolders": [
         {
             "name": "Anfahrten Baustellen",
             "subfolders": [],
            "files": [
                 {
                     "name": "datei1.jpg",
                     "uuid": "cf0b4a7b02d2632554ddd16e62e59d91",
"size": 168147
},
                 {
                     "name": "datei2.gif",
                     "uuid": "2a87e89b1e06392d832a34d9c69f92b9",
"size": 218907
}
             ]
         },
         ...
]
}
}

Rückgabewert	Beschreibung
total_space	verfügbarer Speicherplatz in Byte ungeachtet der aktuellen Auslastung
used_space	aktuell benutzter Speicherplatz in Byte (Achtung: hier zählen auch Dateien aus dem Papierkorb die noch nicht endgültig gelöscht wurden hinein!)
structure	Ordnerstruktur der Dateiablage. Ein Ordner definiert sich jeweils durch seinen Namen, die darin enthaltenen Dateien und Unterordner. Dateien werden durch ihren Namen und die UUID definiert. Ebenfalls im Feld size ist die Dateigröße der Datei in Byte enthalten. Temporär gelöschte Dateien erscheinen im Papierkorb und nicht in ihrem Original-Ordner. Endgültig gelöschte Dateien werden hier nicht mehr angezeigt!