File
BLOB or File storage
The File Model
Properties
-
- Name
_id- Type
- Object ID
- Description
-
ID of this object
-
Create: CurrentUser or AuthenticatedRequestRead: Cannot readUpdate: Cannot update
-
- Name
createdAt- Type
- Date
- Description
-
Date and Time when the object was created.
-
Create: CurrentUser or AuthenticatedRequestRead: Cannot readUpdate: Cannot update
-
- Name
updatedAt- Type
- Date
- Description
-
Date and Time when the object was updated.
-
Create: CurrentUser or AuthenticatedRequestRead: Cannot readUpdate: Cannot update
-
- Name
file- Type
- File Required
- Description
-
-
Create: CurrentUser or AuthenticatedRequestRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
-
- Name
name- Type
- Text Required
- Description
-
Any friendly name of this object
-
Create: CurrentUser or AuthenticatedRequestRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
-
- Name
fileType- Type
- Text Required
- Description
-
-
Create: CurrentUser or AuthenticatedRequestRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
-
- Name
slug- Type
- Slug Required
- Description
-
-
Create: CurrentUser or AuthenticatedRequestRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
-
- Name
isPublic- Type
- Boolean Required
- Description
-
Whether anyone may read the file without signing in. Set by OneUptime: every upload starts private, and a file becomes public only when a record that shows it to everyone, such as a public note or a probe's icon, is published.
-
Create: AutogeneratedRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
-
- Name
imageAccessToken- Type
- Text
- Description
-
-
Create: AutogeneratedRead: CurrentUser or AuthenticatedRequestUpdate: Cannot update
/api/file/get-list
List
This endpoint allows you to retrieve a paginated list of all your File. By default, a maximum of ten File are shown per page.
Optional Query Params
-
- Limit
limit- Type
- number
- Description
- Number of objects to fetch. By default 10, you can increase this count up to 100
-
- Skip
skip- Type
- number
- Description
- Number of objects to skip. This can be useful in pagination
Optional Request Body
-
- Query
query- Type
- query
- Description
- If you would like to filter on File. You can specify include a query here. For more information, please check out writing queries here.
-
- Select
select- Type
- select
- Description
- By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
-
- Sort
sort- Type
- sort
- Description
- Objects will be sorted based on created date by default. You can change the sort order by passing please check how to select here.
List Request
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
}
}
Response
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "b303cdf3-0015-4b27-9330-5ac79633d1b7",
"file": "Example value",
"fileType": "Example value",
"isPublic": true,
"name": "Example name",
"slug": "Example value"
},
{
"_id": "d6a3b04f-ed1d-4f92-baa5-20f5cdab9c20",
"file": "Example value",
"fileType": "Example value",
"isPublic": true,
"name": "Example name",
"slug": "Example value"
},
{
"_id": "ace2c9bc-ccfa-407f-879f-1080b59ba4d8",
"file": "Example value",
"fileType": "Example value",
"isPublic": true,
"name": "Example name",
"slug": "Example value"
}
]
}
/api/file/:id/get-item
Get item by ID
This endpoint allows you to retrieve File by ID.
Required Query Params
-
- ID
id- Type
- text
- Description
- ID of the Object
Optional Request Body
-
- Select
select- Type
- select
- Description
- By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
Get Item Request
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
}
}
Response
{
"_id": "b303cdf3-0015-4b27-9330-5ac79633d1b7",
"file": "Example value",
"fileType": "Example value",
"isPublic": true,
"name": "Example name",
"slug": "Example value"
}
/api/file/count
Count
This endpoint allows you to retrieve the count of all your File.
Optional Request Body
-
- Query
query- Type
- query
- Description
- If you would like to filter on File. You can specify include a query here. For more information, please check out writing queries here.
Count Request
POST/api/file/count
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {
"fileType": "Example value"
}
}
Response
{
"count": 107
}
/api/file
Create File
This endpoint allows you to create a new object.
Request Body
-
- Data
data- Type
- JSON
- Description
- Object to create as JSON
Create Request
POST/api/file
Content-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {
"file": "Example value",
"fileType": "Example value",
"name": "Example name",
"slug": "Example value"
}
}
Response
{
"_id": "b303cdf3-0015-4b27-9330-5ac79633d1b7",
"file": "Example value",
"fileType": "Example value",
"isPublic": true,
"name": "Example name",
"slug": "Example value"
}
Permissions
Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.
Read Permissions
Required to read File
Create Permissions
Required to create File
-
CurrentUser- Logged in User
- This permission is assigned to any registered user.
-
AuthenticatedRequest- AuthenticatedRequest
Update Permissions
Required to update File
Delete Permissions
Required to delete File