AGNX

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
[[:start|Home]] > [[:dev|Developer]] > [[dev:sapi|Lookafter Storage System API]] > **How to specify a path**

====== How to specify a path ======

The "path=" parameter is the most common parameter for storage API and is usually a mandatory one too. The section will lay down the common format adopted by all of them when specifying a path.

But note that the final path is subject to individual API semantic verification. Example, an API may reject a path because it is not pointing to an existing folder.

General form: <ff:'Courier New'>[/][ <AreaName> [/relative_path_to_item | / ] ]</ff>

Examples:\\
<ff:'Courier New'>path=/Private/subdir/My File.doc</ff>  - specifying a particular file.

(Please note that the parameter should be appropriately urlencoded to <ff:'Courier New'>path=%2FPrivate%2Fsubdir%2FMy%20File.doc</ff> but in the examples here we will not do it to avoid the clutter.)

<ff:'Courier New'>path=/</ff>\\ 
This specifies the root, the point where all other storage area begin from.\\ 
<ff:'Courier New'>path=/Company Share</ff> - specifying the Company Share area (folder)\\ 
<ff:'Courier New'>path=Company Share</ff> - the leading / can be dropped

<ff:'Courier New'>path=/Private/subdir/subdir/</ff> - specifying a folder\\ 
<ff:'Courier New'>path=/Private/subdir/subdir</ff> - trailing / not significant

The first part of the path is assumed to be an areaname (toplevel folder), e.g. "Public Share", "Private", etc.
This could be optionally bracketed but should be considered as deprecated format.
The leading "/" is optional, except when specifying "path=/".
The trailing "/" is optional in most API but can be significant in some (e.g. in CopyMove).
AGNX

User Tools

Site Tools

Page Tools
