list
Чтобы получить структуру папок хранилища, используйте метод file/list.
svc=file/list¶ms={"itemId":<long>,
"storageType":<uint>,
"path":<text>,
"mask":<text>,
"recursive":<bool>,
"fullPath":<bool>}
Параметры
| Параметр | Описание |
|---|---|
| itemId | ID элемента. |
| storageType | Тип хранилища: 1 - общедоступное (все пользователи могут видеть и скачивать файлы), 2 - закрытое (видеть и скачивать файлы могут только пользователи с правом доступа Просмотр и скачивание файлов на элемент). |
| path | Относительный путь от корневой папки к папке. |
| mask | Маска имени файла. Может содержать звездочку (*), которая заменяет 0 или более символов, и вопросительный знак (?), который заменяет 1 символ. Если вы указываете несколько масок, разделяйте их запятыми. |
| recursive | Флаг, который определяет, нужно ли отображать содержимое рекурсивно, с вложенными папками. |
| fullPath | Флаг, который определяет, нужно ли показывать полный путь к элементам. |
Размещать и удалять файлы может только создатель элемента.
Ответ
В случае успешного выполнения запроса возвращается структура хранилища. Сигнатура n/c означает, что элемент иерархии является папкой, сигнатура n/s — что это файл.
[
{
"n": <text>, /* имя папки; если "fullPath":true, путь от корневой папки */
"c": [...] /* содержимое папки, может включать файлы и/или папки; возвращается, если "recursive":true */
},
{
"n": <text>, /* имя файла; если "fullPath":true, путь от корневой папки */
"s": <uint>, /* размер файла (в байтах) */
"ct": <uint>, /* время создания файла, UNIX-время */
"mt": <uint> /* время последнего изменения файла, UNIX-время */
},
...
]
В случае неудачного выполнения запроса возвращается код ошибки.
Коды ошибок
| Код | Описание |
|---|---|
| 1 | Пользователь не авторизован. |
| 4 | Некорректные входные параметры. |
| 5 | Не удалось получить список файлов по указанному пути. |
| 7 | Элемент, указанный в параметре itemId, не найден, или у вас нет права доступа Просмотр и скачивание файлов на него (для закрытого хранилища). |