ClickHelp User Manual

Get File

Returns information on a single file.

GET storage/{file-path}?format={file-encode-format}

Authentication

This request requires basic authentication.

Request Parameters

Path params
file-path
string
File path relative to the root, i.e., everything after ...resources/Storage/.
Query params
format string
[optional] File encoding. Currently, only base64 is supported. If not specified, does not return content.

Samples

Request sample
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/storage/project-deep-space-exploration/info.png?format=base64'
Response body sample
JSON
{
"fileName": "info.png",
"fileFullName": "Storage\\project-deep-space-exploration\\info.png",
"content": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAQklEQVQ4y2P0av/xn4ECwMRAIcBrwNYKdoatFey0dQELPknvjp/kG4DsdHwGMVFiO+1jYdQACg1ATgf4kjPLgKcDAL8dECIPWD7kAAAAAElFTkSuQmCC",
"modifiedBy": "katherine",
"modifiedOn": "2021-04-07T15:50:15",
"size": 123,
"isFolder": false
}

Response fields

fileName
File name and extension.
fileFullName
Full file name, including the base Storage/ folder.
content
Base64-encoded file content.
modifiedBy
Login of the user the file was last modified by.
modifiedOn
An ISO 8601 timestamp of the file modification date. GMT timezone.
size
File size in bytes.
isFolder
Whether the entity is a file or a folder.