DigitalContent - OgnianApostolov/builderly-api-docs GitHub Wiki

Model

DigitalContent digitalContent {
    "_id": {
        "autogenerated": "true"
    },
    "name": {
        "type": "string",
        "required": "true"
    },
    "type": {
        "type": "string",
        "required": "true"
    },
    "file": {
        "type": "buffer",
        "required": "true"
    },
    "createdAt": {
        "autogenerated": "true"
    },
    "updatedAt": {
        "autogenerated": "true"
    }
}

Methods

Create new

POST /digital-content req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/digital-content’,
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: 
}

Responses Success - status 201

{}

Error - status 400

{
    error_message
}

Retrieve multiple

GET /digital-content

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/digital-content',
    headers: {},
    json: true,
    body: {}
}

Responses Success - status 200

[ digital-content ]

Error - status 500

{
    error_message
}
  • Example usages: /digital-content - Get all digital contents

Retrieve single

GET /digital-content/:id

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/digital-content/{{digital-content._id}}',
    headers: {},
    json: true,
    body: {}
}

Responses Success - status 200

{
    digital_content.file
}

Not found - status 404

{}
  • Example usages: /digital-content/:id - Retrives a specific digital content

Update single

PATCH /digital-content/:id

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/digital-content/{{digital-content._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: 
}

Responses Success - status 200

{ digital-content }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE /digital-content/:id

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/digital-content/{{digital-content._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ digital-content }

Not found - status 404

{}

Error - status 500

{
    error_message
}