Returns a list of File System root resources.
The Root of the File System consists of devices in the File System such as C , D etc. drive on VC and /hda0, /bd:02 etc. on RC.
The Root also supports environment variables:
The following environment variables are supported:
- Home
- Release
- System
- Temp
- Options
- Backup
- Internal
Syspar
Within the URI, the environment variables are specified in all small case and preceded with the dollar $
character e.g. $home, $temp etc The list contains a list of all devices in file system, their type, available free space and total capacity of each device.
URL
/fileservice
Method
GET
URL Params
None
See Common URL parameters
Data Params
None
Success Response
HTTP_OK(200)
Example Response
<?xml version="1.0" encoding="utf-8"?>
<html
xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>File Service</title>
<base href="http://10.140.60.61/fileservice/" />
</head>
<body>
<div class="state">
<a href="" rel="self"></a>
<ul>
<li class="fs-device" title="hd0a">
<a href="" rel="parent"></a>
<a href="hd0a" rel="self"></a>
<span class="fs-device-type">fixed</span>
<span class="fs-free-space">873164800</span>
<span class="fs-total-space">2068717568</span>
<span class="fs-enabled">true</span>
<span class="fs-readonly">false</span>
</li>
</ul>
</div>
</body>
</html>
Resources
- fs-device
- fs-device-type One of
fixed
, removable
, ramdisk
, remote
or unknown
.
- fs-total-space Total capacity of the media in bytes
- fs-free-space Available free space on the media in bytes.
- fs-enabled If the device is accessible, typically if you add a device before you set it as enabled
- fs-readonly TRUE if read only else FALSE
Error Response
UNAUTHORIZED(401),NOT_FOUND(404)
See Robot controller return codes
Sample Call
Get a list of root resources
curl --digest -u "Default User":robotics "http://localhost/fileservice"
Notes
- Though root supports environment variables these are not listed in the returned response.
- Environment variables are only allowed directly under the root URI i.e. /fileservice/$home
- Supported in bootserver mode