Media - OgnianApostolov/builderly-api-docs GitHub Wiki
Model
Media media {
"_id": {
"autogenerated": "true"
},
"file": {
"type": "buffer"
},
"alt": {
"type": "string"
},
"filename": {
"type": "string"
},
"filetype": {
"type": "string"
},
"owner_id": {
"ref": "User.ObjectID"
},
"createdAt": {
"autogenerated": "true"
},
"updatedAt": {
"autogenerated": "true"
}
}
Methods
Create new
POST /medias?ionic=true
req.body required
method: 'POST'
{
url: 'https://{{your-builderly-domain}}/medias?ionic=true',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body:
}
Responses
Success - status 201 || Success - status 302
{} || (req.headers.referer)
Error - status 400
{
error_message
}
Retrieve single
GET /medias/:id
method: 'GET'
{
url: 'https://{{your-builderly-domain}}/medias/{{media._id}}',
headers,
json: true,
body: {}
}
Responses
Success - status 200
media.file
Not found - status 404
{}
- Example usages:
/medias/:id
- Retrives a specific media
Update single
PATCH /medias/:id
method: 'PATCH'
{
url: 'https://{{your-builderly-domain}}/medias/{{media._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{}
Not found - status 404
{}
Delete single
DELETE /medias/:id
method: 'DELETE'
{
url: 'https://{{your-builderly-domain}}/medias/{{media._id}}',
headers: {
'Authorization': 'Bearer ' + token
},
json: true,
body: {}
}
Responses
Success - status 200
{ media }
Not found - status 404
{}
Error - status 500
{
error_message
}