Справочный центр Wialon

list

Чтобы увидеть структуру хранилища, используйте метод file/list.

Copied!
svc=file/list&params={
	"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 — файл.

Copied!
[
  {
    "n": <text>,           /* путь к указанной папке, начинается с «public» или «protected» */
    "c": [                 /* содержимое корневой папки, может включать файлы и/или вложенные папки */
      {
        "n": <text>,       /* имя папки */
        "c": [ ... ]       /* содержимое папки, может включать файлы и/или вложенные папки */
      },
      {
        "n": <text>,       /* имя файла */
        "s": <text>        /* размер файла (байт) */
      }
      // ...
    ]
  }
]

Если запрос выполнить не удалось, возвращается код ошибки.

Коды ошибок

Код

Описание

1Пользователь не авторизован.
4Пользователь не авторизован.
5Не удалось получить список файлов по указанному пути.
7IНедостаточно прав на элемент, указанный в параметре itemId.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.

Сообщить об ошибке

Ваше сообщение отправлено. Спасибо!

Произошла ошибка при отправке формы

Скачать файл PDF
Скачать документ Word

Смотрите также