Page tree
Skip to end of metadata
Go to start of metadata

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

GET   /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

return json
{
	"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!

  • No labels