Получение списка публичных ресурсов, которыми владеет сотрудник

Метод возвращает список всех ресурсов сотрудника, к которым он предоставил публичный доступ.

Необходимые права доступа для OAuth-приложения:

cloud_api:disk.read

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

Метод: GET.

https://cloud-api.yandex.net/v1/disk/public/resources/admin/public-resources
 ? user_id=<идентификатор (UID) сотрудника организации>
 & org_id=<идентификатор организации>
 & [limit=<ограничение на количество возвращаемых ресурсов в ответе>]
 & [offset=<смещение относительно начала списка>]

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

user_id*

Идентификатор (UID) сотрудника организации.

org_id*

Идентификатор организации в Яндекс 360 для бизнеса.

Чтобы посмотреть идентификатор в интерфейсе, откройте кабинет организации и выберите Общие настройки → Профиль организации. Идентификатор будет указан под названием организации.

limit

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

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

offset

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

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

* Обязательный параметр.

Authorization: OAuth <token>

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

Успешный ответ

Если запрос был обработан без ошибок, API отвечает кодом 200 OK и возвращает ссылку на опубликованный ресурс в теле ответа (в объекте ResourceListShort).

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

{
    "items": [
        {
            "created_at": "2018-01-28T12:08:48.372+03:00",
            "public_hash": "R6S/Qw7oKwz2PM7DC1koM+p4QtVSb+jFDVU4QwKCoadwq9AOoMLHPuvojlS6t7TOq/J6bpmRyOJonT3VoXnDag==",
            "modified_at": "2018-01-28T12:08:48.372+03:00",
            "name": "aa_dir",
            "path": "/disk/aa_dir",
            "type": "dir"
        }
    ],
    "limit": 1,
    "offset": 0
}

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

ResourceListShort

Элемент	Описание
`items`	Массив описаний публичных ресурсов (ResourceShort).
`limit`	Максимальное количество элементов в массиве `items`, заданное в запросе.
`offset`	Смещение начала списка от первого ресурса в папке.

ResourceShort

Элемент	Описание
`public_hash`	Ключ опубликованного ресурса. Включается в ответ только если указанный файл или папка опубликован.
`created_at`	Дата и время создания ресурса, в формате ISO 8601.
`modified_at`	Дата и время изменения ресурса, в формате ISO 8601.
`name`	Имя ресурса.
`path`	Полный путь к ресурсу на Диске. В метаинформации опубликованной папки пути указываются относительно самой папки. Для опубликованных файлов значение ключа всегда «/». Для ресурса, находящегося в Корзине, к атрибуту может быть добавлен уникальный идентификатор (например, `trash:/foo_1408546879`). С помощью этого идентификатора ресурс можно отличить от других удаленных ресурсов с тем же именем.
`type`	Тип ресурса: «dir» — папка; «file» — файл.

Ответ с ошибкой

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

Некоторые возможные ошибки:

400 — Некорректный запрос.
401 — Не авторизован.
403 — API недоступно. Ваши файлы занимают больше места, чем у вас есть. Удалите лишнее или увеличьте объём Диска. / Отправитель запроса не является администратором в организации.
404 — Не удалось найти запрошенный ресурс. / Пользователь с user_id не состоит в организации, в которой состоит администратор.
503 — Сервис временно недоступен.

Была ли статья полезна?

Получение по идентификатору ресурса

Список публичных ресурсов, к которым есть доступ у сотрудника