Public Web API: File search

Returns a list of the platform’s file storage file models, formed based on the search parameters
provided.

Request

POST /pub/v1/disk/files/search

Request body

The resource sent in the request body is File search — Request. It contains the following writable properties:

{
    "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"
}

Properties

Name	Type	Description	Additional
filter	object	Filter parsing structures	Optional
filter.__changedBy	uuid	ID of the user who edited the file	Optional
filter.__createdAt	object	Scope of dates for filtering	Optional
filter.__createdAt.max	date-time	End date (inclusive)	Optional
filter.__createdAt.min	date-time	Start date (inclusive)	Optional
filter.__createdBy	uuid	ID of the user who created the file	Optional
filter.__name	string	File name (partial match search)	Optional
filter.__updatedAt	object	Scope of dates for filtering	Optional
filter.__updatedAt.max	date-time	End date (inclusive)	Optional
filter.__updatedAt.min	date-time	Start date (inclusive)	Optional
filter.directory	uuid	Directory ID	Optional
from	uint32	Return starting from item	Optional
size	uint32	Number of returned items (10000 max)	Optional

Authorization

This request requires the use of one of following authorisation methods: API key

Response

The following HTTP status codes may be returned:

Status code	Description	Resource
200	OK File search response model	File search response model (File search)
400	Bad Request Invalid request parameters
422	File search response model	File search response model (File search)