Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Abrufen der aktuellen Ordnerstruktur aus der Dateiablage inklusive der Dateien und UUIDs zur Referenz für die [[modifiy_file.php>>doc:YellowFox Remote Tracking Interface.Funktionen.Dateiablage.file_storagemodify_file\.php.WebHome]] oder um die Datei per [[do_order>>doc:YellowFox Remote Tracking Interface.Funktionen.Aufträge und Nachrichten.do_order\.php.WebHome]] bzw. [[do_message>>doc:YellowFox Remote Tracking Interface.Funktionen.Aufträge und Nachrichten.do_message\.php.WebHome]] zu nutzen. Außerdem wird die aktuelle Auslastung mit angegeben.
6 = Beschreibung =
7 (% class="green mark" %)GET(%%)//** /file_storage/get_overview.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY//
8 = Parameter =
9 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 |company|RTI Firmenschlüssel|string||ja
11 |import|RTI Importschlüssel|string||ja
12
13 = Rückgabe =
14 Die Rückgabe erfolgt im JSON-Format. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
15
16 **Rückgabebeispiel**
17 **Rückgabe als JSON**
18 {{code language="java"}}{
19 "total_space": ?,
20 "used_space": ?,
21 "structure": {
22 "name": "Meine Ablage",
23 "subfolders": [
24 {
25 "name": "Anfahrten Baustellen",
26 "subfolders": [],
27 "files": [
28 {
29 "name": "datei1.jpg",
30 "uuid": "cf0b4a7b02d2632554ddd16e62e59d91",
31 "size": 168147                  
32 },
33 {
34 "name": "datei2.gif",
35 "uuid": "2a87e89b1e06392d832a34d9c69f92b9",
36 "size": 218907                  
37 }
38 ]
39 },
40 ...
41 ]
42 }
43 }{{/code}}
44
45 |=Rückgabewert|=Beschreibung
46 |total_space|verfügbarer Speicherplatz in Byte ungeachtet der aktuellen Auslastung
47 |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!)
48 |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.
49 Ebenfalls im Feld size ist die Dateigröße der Datei in Byte enthalten.
50 Temporär gelöschte Dateien erscheinen im Papierkorb und nicht in ihrem Original-Ordner.
51 Endgültig gelöschte Dateien werden hier nicht mehr angezeigt!
52