GET /files
With this resource, the encode parameters (see below) are very useful when navigating with a browser.
To access this resource with something other than the browser, use the header accept and not the encode query parameter.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
Optional: Yes
Located In: Query
Example Values: encode=json
If this parameter is not in the request, the Application/Json will be chosen by default. JSON and XML are the most commonly used values. There are multiple possible values (according the resource):
Optional: Yes
Located In: Header
Example Values: accept:application/json
| Property Name | Type | Description | Method |
|---|---|---|---|
| FileName | String | This is the name of the file. | GET |
| Modified | String | This is the date and time of the last file update. | GET |
| Size | Integer | This is the file size. | GET |
| Property Name | Type | Description | Method |
|---|---|---|---|
| DirectoryName | String | This is the name of the folder. | GET |
| NbFilesDir | Integer | This is the number of elements inside this folder (files and folders). | GET |
| FileFolders | Array <FileFolder> |
This contains a large number of FIleFolders. This represents all the folders that exists in this current folder. | GET |
| Files | Array <File> |
This contains a variety of files that represents all the files existing inside this current folder. | GET |
URL Example: https://0.0.0.0/api/rest/v1/files/licenses/license.xml
{
"fileName": "license.xml",
"size": 2233,
"modified": "04/19/2016 12:11:29"
}
URL Example: https://0.0.0.0/api/rest/v1/files/folderRepresentation
{
"files": [
{
"path": {
"href": "/api/rest/v1/files/folderRepresentation/FileName.txt",
"name": "FileName.txt"
},
"modified": "04/20/2016 12:47:19",
"size": 936
}
],
"directoryName": "folderRepresentation",
"fileFolders": [
{
"path": {
"href": "/api/rest/v1/files/folderRepresentation/childFolder",
"name": "childFolder"
},
"nbFilesDir": 0
}
],
"nbFilesDir": 2
}
URL Example: https://0.0.0.0/api/rest/v1/files/licenses/license.xml
<?xml version="1.0" encoding="utf-8"?>
<File>
<FileName>license.xml</FileName>
<Modified>04/19/2016 12:11:29</Modified>
<Size>2233</Size>
</File>
URL Example: https://0.0.0.0/api/rest/v1/files/folderRepresentation
<?xml version="1.0" encoding="utf-8"?>
<FileFolder>
<DirectoryName>folderRepresentation</DirectoryName>
<NbFilesDir>2</NbFilesDir>
<FileFolders>
<FileFolder>
<Path>
<Href>
/api/rest/v1/files/folderRepresentation/childFolder
</Href>
<Name>childFolder</Name>
</Path>
<NbFilesDir>0</NbFilesDir>
</FileFolder>
</FileFolders>
<Files>
<File>
<Path>
<Href>
/api/rest/v1/files/folderRepresentation/FileName.txt
</Href>
<Name>FileName.txt</Name>
</Path>
<Size>936</Size>
<Modified>04/20/2016 12:47:19</Modified>
</File>
</Files>
</FileFolder>