Публичный Web API: Поиск файлов

Возвращает список моделей файлов файлового хранилища платформы, сформированный по условиям, заданными параметрами
поиска.

Запрос

POST /pub/v1/disk/files/search

Тело запроса (body)

Тело запроса принимает ресурс  Поиск файлов — Request. Содержит следующие доступные для записи свойства:

{
    "filter": {
        "__changedBy": "uuid",
        "__createdAt": {
            "max": "date-time",
            "min": "date-time"
        },
        "__createdBy": "uuid",
        "__name": "string",
        "__updatedAt": {
            "max": "date-time",
            "min": "date-time"
        },
        "directory": "uuid"
    },
    "from": "uint32",
    "size": "uint32"
}

Свойства

Имя Тип Описание Дополнительно
filter object

Структуры для парсинга фильтра

Опциональное
filter.__changedBy uuid

Идентификатор пользователя, изменившего файл

Опциональное
filter.__createdAt object

Диапазон дат для фильтрации

Опциональное
filter.__createdAt.max date-time

Максимальная дата (включительно)

Опциональное
filter.__createdAt.min date-time

Минимальная дата (включительно)

Опциональное
filter.__createdBy uuid

Идентификатор пользователя, создавшего файл

Опциональное
filter.__name string

Название файла (поиск по частичному совпадению)

Опциональное
filter.__updatedAt object

Диапазон дат для фильтрации

Опциональное
filter.__updatedAt.max date-time

Максимальная дата (включительно)

Опциональное
filter.__updatedAt.min date-time

Минимальная дата (включительно)

Опциональное
filter.directory uuid

Идентификатор директории

Опциональное
from uint32

Возвращать начиная с элемента

Опциональное
size uint32

Количество возвращаемых элементов (максимум 10000)

Опциональное

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP:

HTTP-статус Описание Модель ответа
200 OK

Модель ответа поиск файлов

Модель ответа поиск файлов (Поиск файлов)
400 Bad Request

Неверные параметры запроса