Ресурс
File
BLOB or File storage
Модель File
Свойства
- Имя
_id- Тип
- Object ID
- Описание
ID of this object
- Имя
createdAt- Тип
- Date
- Описание
Date and Time when the object was created.
- Имя
updatedAt- Тип
- Date
- Описание
Date and Time when the object was updated.
- Имя
file- Тип
- FileОбязательно
- Описание
- Имя
name- Тип
- TextОбязательно
- Описание
Any friendly name of this object
- Имя
fileType- Тип
- TextОбязательно
- Описание
- Имя
slug- Тип
- SlugОбязательно
- Описание
- Имя
isPublic- Тип
- SlugОбязательно
- Описание
GETorPOST
/api/file/get-listСписок
Этот метод возвращает постраничный список ваших объектов «File». По умолчанию на странице до десяти записей.
Необязательные query-параметры
limit- число
- Сколько объектов вернуть. По умолчанию 10, максимум 100
skip- число
- Сколько объектов пропустить (для пагинации)
Необязательное тело запроса
query- Чтобы фильтровать File, укажите запрос здесь. Подробнее: написание запросов.
select- По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort- По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.
Запрос списка
POST/api/file/get-list?skip=0&limit=10Заголовки
Content-Type: application/json ApiKey: YOUR_API_KEY
Тело
{
"select": {
"file": true,
"fileType": true,
"isPublic": true,
"name": true,
"slug": true
},
"query": {
"fileType": "Example value"
},
"sort": {
"createdAt": -1
}
}Ответ
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "376eab80-28fe-11f1-b591-3fdcef396aba",
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
},
{
"_id": "376eab81-28fe-11f1-b591-3fdcef396aba",
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
},
{
"_id": "376eab82-28fe-11f1-b591-3fdcef396aba",
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
}
]
}GETorPOST
/api/file/:id/get-itemПолучить по ID
Возвращает объект «File» по идентификатору.
id- строка
- ID объекта
Необязательное тело запроса
select- По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
Запрос одного объекта
POST/api/file/:id/get-itemЗаголовки
Content-Type: application/json ApiKey: YOUR_API_KEY
Тело
{
"select": {
"file": true,
"fileType": true,
"isPublic": true,
"name": true,
"slug": true
}
}Ответ
{
"_id": "376eab80-28fe-11f1-b591-3fdcef396aba",
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
}POST
/api/file/countКоличество
Возвращает количество ваших объектов «File».
Необязательное тело запроса
query- Чтобы фильтровать File, укажите запрос здесь. Подробнее: написание запросов.
Запрос количества
POST/api/file/countЗаголовки
Content-Type: application/json ApiKey: YOUR_API_KEY
Тело
{
"query": {
"fileType": "Example value"
}
}Ответ
{
"count": 107
}POST
/api/fileСоздать File
Создаёт новый объект.
Запрос создания
POST/api/fileЗаголовки
Content-Type: application/json ApiKey: YOUR_API_KEY
Тело
{
"data": {
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
}
}Ответ
{
"_id": "376eab80-28fe-11f1-b591-3fdcef396aba",
"file": "Example value",
"fileType": "Example value",
"isPublic": "Example value",
"name": "Example name",
"slug": "Example value"
}Права доступа
Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.
Права на чтение
Нужны для чтения File
Ресурс нельзя читать через API
Права на создание
Нужны для создания File
Logged in UserAuthenticatedRequest
Права на обновление
Нужны для обновления File
Ресурс нельзя обновить через API
Права на удаление
Нужны для удаления File
Ресурс нельзя удалить через API