Плоский список всех файлов

API возвращает плоский список всех файлов на Диске в алфавитном порядке. Плоский список не учитывает структуру каталогов, поэтому в нем удобно искать файлы определенного типа, разбросанные по разным папкам.

Формат запроса

Запрос списка всех файлов следует отправлять с помощью метода GET.

https://cloud-api.yandex.net/v1/disk/resources/files
 ? [limit=<количество файлов в списке>]
 & [media_type=<тип запрашиваемых файлов>]
 & [offset=<смещение относительно начала списка>]
 & [fields=<свойства, которые нужно включить в ответ>]
 & [preview_size=<размер превью>]
 & [preview_crop=<признак обрезки превью>]

Описание query-параметров

limit

Количество файлов, описание которых следует вернуть в ответе (используется для постраничного вывода).

Значение по умолчанию — 20.

media_type

Тип файлов, которые нужно включить в список. Диск определяет тип каждого файла при загрузке.

Чтобы запросить несколько типов файлов, можно перечислить их в значении параметра через запятую. Например, media_type="audio,video".

Поддерживаемые типы:

• audio — аудио-файлы.
• backup — файлы резервных и временных копий.
• book — электронные книги.
• compressed — сжатые и архивированные файлы.
• data — файлы с базами данных.
• development — файлы с кодом (C++, Java, XML и т. п.), а также служебные файлы IDE.
• diskimage — образы носителей информации и сопутствующие файлы (например, ISO и CUE).
• document — документы офисных форматов (Word, OpenOffice и т. п.).
• encoded — зашифрованные файлы.
• executable — исполняемые файлы.
• flash — файлы с флэш-видео или анимацией.
• font — файлы шрифтов.
• image — изображения.
• settings — файлы настроек для различных программ.
• spreadsheet — файлы офисных таблиц (Excel, Numbers, Lotus).
• text — текстовые файлы.
• unknown — неизвестный тип.
• video — видео-файлы.
• web — различные файлы, используемые браузерами и сайтами (CSS, сертификаты, файлы закладок).

offset

Количество ресурсов с начала списка, которые следует опустить в ответе (например, для постраничного вывода).

Допустим, папка /doc содержит три файла. Если запросить метаинформацию о папке с параметром offset=1, API Диска вернет только описания второго и третьего файла.

fields

Список свойств JSON, которые следует включить в ответ. Ключи, не указанные в этом списке, будут отброшены при составлении ответа. Если параметр не указан, ответ возвращается полностью, без сокращений.

Имена ключей следует указывать через запятую, а вложенные ключи разделять точками. Например: name,_embedded.items.path.

preview_size

Требуемый размер уменьшенного изображения (превью файла), ссылку на которое Диск должен вернуть в ключе preview.

Вы можете задать как точный размер превью, так и размер одной из сторон. Получившееся изображение можно обрезать до квадрата с помощью параметра preview_crop.

Варианты значений

• Предопределенный размер большей стороны.

  Картинка уменьшается до указанного размера по большей стороне, пропорции исходного изображения сохраняются. Например, для размера S и картинки размером 120×200 будет сгененерировано превью размером 90×150, а для картинки 300×100 — превью размером 150×50.

  Поддерживаемые значения:

  -"S" — 150 пикселей;
  -"M" — 300 пикселей;
  -"L" — 500 пикселей;
  -"XL" — 800 пикселей;
  -"XXL" — 1024 пикселей;
  -"XXXL" — 1280 пикселей.

• Точная ширина (например, "120" или "120x") или точная высота (например, "x145").

  Картинка уменьшается до указанной ширины или высоты, пропорции исходного изображения сохраняются.

  Если передан параметр preview_crop, из центра уменьшенного изображения также вырезается квадрат с заданной стороной.

• Точный размер (в формате <ширина>x<высота>, например "120x240").

  Картинка уменьшается до меньшего из указанных размеров, пропорции исходного изображения сохраняются.

  Если передан параметр preview_crop, из центра оригинального изображения вырезается фрагмент максимального размера в заданных пропорциях ширины и высоты (в примере — один к двум). Затем вырезанный фрагмент масштабируется до указанных размеров.

preview_crop

Параметр позволяет обрезать превью согласно размеру, заданному в значении параметра preview_size.

Допустимые значения:

• false — параметр игнорируется (по умолчанию).
• true — превью обрезается следующим образом:
  
  
  • Если передана только ширина или высота, картинка уменьшается до этого размера с сохранением пропорций. Затем из центра уменьшенного изображения также вырезается квадрат с заданной стороной.
    
  • Если передан точный размер (например, "120x240"), из центра оригинального изображения вырезается фрагмент максимального размера в заданных пропорциях ширины и высоты. Затем вырезанный фрагмент масштабируется до указанных размеров.

Заголовок

Authorization: OAuth <token>

Формат ответа

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает метаинформацию о запрошенном количестве файлов в теле ответа в объекте FilesResourceList.

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

Пример ответа:

{
  "items": [
      {
        "name": "photo2.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-22T14:57:13+04:00",
        "modified": "2014-04-22T14:57:14+04:00",
        "path": "disk:/foo/photo2.png",
        "md5": "53f4dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 54321
      },
      {
        "name": "photo1.png",
        "preview": "https://downloader.disk.yandex.ru/preview/...",
        "created": "2014-04-21T14:57:13+04:00",
        "modified": "2014-04-21T14:57:14+04:00",
        "path": "disk:/foo/photo1.png",
        "md5": "4334dc6379c8f95ddf11b9508cfea271",
        "type": "file",
        "mime_type": "image/png",
        "size": 34567
      }
    ],
    "limit": 20,
    "offset": 0
  }

Описание элементов ответа

Значение по умолчанию — 20.

Допустим, папка /doc содержит три файла. Если запросить метаинформацию о папке с параметром offset=1, API Диска вернет только описания второго и третьего файла.