Запросить демо
Запросить демо
Документерра: руководство пользователя

[API] Получение файла

Получение информации об одном файле.

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

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
file-path
string
Путь к файлу относительно корня, т.е. все, что после ... resources/Storage/.
Параметры поискового запроса
format string
[опционально] Кодировка файла. В настоящее время поддерживается только base64. Если не указано, то контент не выдается .

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request GET 'https://{portal-url}/api/v1/storage/project-deep-space-exploration/info.png?format=base64'
Образец тела ответа
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
}

Поля ответа

fileName
Имя и расширение файла.
fileFullName
Полное имя файла, включая основную папку Storage/.
content
Контент файла в кодировке Base64.
modifiedBy
Логин пользователя, который последним изменял файл.
modifiedOn
Временная метка ISO 8601 даты изменения файла. Часовой пояс GMT.
size
Размер файла в байтах.
isFolder
Определяет, является ли объект файлом или папкой.