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

[API] Получение информации о нескольких файлах

Получение информации о файлах и папках, расположенных внутри указанной папки.

GET storage/{file-path}? filter={file-filter}&isRecursive={is-recursive}

Авторизация

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

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

Параметры пути

file-path	string	Путь к папке относительно корня, т.е. все, что после ... resources/Storage/.

Параметры поискового запроса

filter	string	Маска имени файла. Поддерживается только подстановочный символ * .
isRecursive	bool	[опционально] Определяет, следует ли рекурсивно выдавать все папки и содержащиеся в них файлы, т. е. извлекать все вложенные папки. По умолчанию значение false (ложно).

Образцы

Образец запроса

Copy Code

Bash (Unix Shell)

curl --location -g --request GET 'https://{portal-url}/api/v1/storage/project-deep-space-exploration/info.png?format=base64&filter=*&isRecursive=true'

Образец тела ответа

Copy Code

JSON

[
    {
        "fileName": "2b7f5b28-771e-46fc-9b60-427c6f6e10d9.gif",
        "fileFullName": "Storage\\project-deep-space-exploration\\2b7f5b28-771e-46fc-9b60-427c6f6e10d9.gif",
        "content": null,
        "modifiedBy": "jen",
        "modifiedOn": "2022-05-06T08:16:29",
        "size": 490,
        "isFolder": false
    },
    {
        "fileName": "Artist_Concept_Planetary_System.jpg",
        "fileFullName": "Storage\\project-deep-space-exploration\\Artist_Concept_Planetary_System.jpg",
        "content": null,
        "modifiedBy": "admin",
        "modifiedOn": "2022-09-27T12:45:57",
        "size": 80801,
        "isFolder": false
    }
]

Поля ответа

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

[API] Получение файла [API] Создание файла или папки