FilesResource

The following resources are part of this group:

/files

The following operations are supported on this resource:

GET

Lists the user home directory.

Parameters

name description type default
sortBy specifies the sort by attribute. Possible values: "fileName", "lastModifiedTime", "size". query
order the sort direction. Possible values: "ASC" or "DESC". query
transferMode specifies the file transfer mode: ASCII or BINARY; query
status if present in the query string will return all metadata for the user home directory. query
offset the start row to list; if this parameter is not set, then it is considered 0. query
limit the limit of the listed rows; if this parameter is not set, then it is considered to list all rows. query
showdots whether to display or hide hidden files and folders (starting with a dot) query true
version (no documentation provided) path

Response Body

element: (custom)

a list of files.

POST

Uploads file to the user home folder. The filename is gotten from Content-Disposition header.

Parameters

name description type default
transferMode the transfer mode, read from the request query string query
version (no documentation provided) path

Response Body

element: (custom)

uploads the file and lists the user home directory.

POST

Updates the user home folder metadata.

Parameters

name description type default
version (no documentation provided) path

Request Body

element: file

the new the user home folder metadata

Response Body

element: (custom)

the response

/files/{filepath}

The following operations are supported on this resource:

GET

Returns a list if files, if the specified file is directory, otherwise the file content. If the file path contains GLOB characters a listing will be performed. If status parameter is present will return the file metadata.

Parameters

name description type default
filepath the target file path path
sortBy specifies the sort by attribute. Possible values: "fileName", "lastModifiedTime", "size". query
order the sort direction. Possible values: "ASC" or "DESC". query
transferMode specifies the file transfer mode: ASCII or BINARY; query
status if present in the query string will return all metadata for the specified file. query
offset the start row to list; if this parameter is not set, then it is considered 0. query
limit the limit of the listed rows; if this parameter is not set, then it is considered to list all rows. query
showdots whether to display or hide hidden files and folders (starting with a dot) query true
version (no documentation provided) path

Response Body

element: (custom)

a list if files, if the specified file is directory, otherwise the file content or file metadata if status parameter is present in the query string.

DELETE

Deletes the file or directory, specified by the file path argument.

Parameters

name description type default
filepath the file to delete. path
version (no documentation provided) path

Response Body

element: (custom)

a response.

PUT

Creates a file or directory with specified filepath.

Parameters

name description type default
filepath the full file path, including file name. path
version (no documentation provided) path

Request Body

element: file

the file metadata, specifies whether should create regular file or directory.

Response Body

element: (custom)

the response.

POST

Uploads file to the folder, pointed by the filepath. The filename is gotten from Content-Disposition header.

Parameters

name description type default
filepath the location where the file will be uploaded. path
transferMode the transfer mode, read from the request query string query
version (no documentation provided) path

Response Body

element: (custom)

uploads the file and lists the folder, pointed by the filepath.

PUT

Uploads file. Any Content-Type is accepted.

Parameters

name description type default
filepath the location where the file will be uploaded together with the filename path
transferMode the transfer mode, read from the request query string query
version (no documentation provided) path

Response Body

element: (custom)

uploads the file to the location given in the filepath.

POST

Updates metadata of the file, pointed by the filepath. If the file name stored in the File object is different then the one in the filepath will rename the target file/directory.

Parameters

name description type default
filepath the file oath path
version (no documentation provided) path

Request Body

element: file

the new file metadata

Response Body

element: (custom)

the response