Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

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

Status
colourGreen
titleGET
 /file_storage/get_overview.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja

Rückgabe

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


Rückgabebeispiel

Code Block
{
	"total_space": ?,
	"used_space": ?,
	"structure": {
    	"name": "Meine Ablage",
    	"subfolders": [
        	{
            	"name": "Anfahrten Baustellen",
            	"subfolders": [],
           	 	"files": [
                	{
                    	"name": "datei1.jpg",
                    	"uuid": "cf0b4a7b02d2632554ddd16e62e59d91"
                	},
                	{
                    	"name": "datei2.gif",
                    	"uuid": "2a87e89b1e06392d832a34d9c69f92b9"
                	}
            	]
        	},
        	...
		]
	}
}


RückgabewertBeschreibung
total_spaceverfügbarer Speicherplatz in Byte ungeachtet der aktuellen Auslastung
used_spaceaktuell 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.

Temporär gelöschte Dateien erscheinen im Papierkorb und nicht in ihrem Original-Ordner.

Endgültig gelöschte Dateien werden hier nicht mehr angezeigt!


Sv translation
languageen

Get the current directory structure of file storage including the files and their uuids to reference them for modifiy_file.php or attach them via do_order resp. do_message. Furthermore you will get the current usage.

Description

Status
colourGreen
titleGET
   /file_storage/get_overview.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY

Parameters

parameter

description

type

hint

mandatory

companyRTI company keystring
yes
importRTI import keystring
yes

Return

Return value is a JSON. On missing parameters you will receive "ERROR:description".


return example

Code Block
{
	"total_space": ?,
	"used_space": ?,
	"structure": {
    	"name": "my storage",
    	"subfolders": [
        	{
            	"name": "access construction area",
            	"subfolders": [],
           	 	"files": [
                	{
                    	"name": "file1.jpg",
                    	"uuid": "cf0b4a7b02d2632554ddd16e62e59d91"
                	},
                	{
                    	"name": "file2.gif",
                    	"uuid": "2a87e89b1e06392d832a34d9c69f92b9"
                	}
            	]
        	},
        	...
		]
	}
}


return valuedescription
total_spaceavailable storage space in byte without considering current usage
used_spacecurrently used storage space in byte (attention: files from bin which are not deleted permanently will also add to this!)
structure

Directory structure of file storage. A directory is defined by a name and the contained files and sub directories. Files are defined by their name and uuid.

Temporarly deleted files are shown in bin and not their original directory.

Permanently deleted files will not be shown!