rest.blob.views

REST views for the blob API

class rest.blob.views.BlobDeleteList(**kwargs)

Bases: rest_framework.views.APIView

Delete a list of Blob

patch(request)

Delete a list of Blob

Parameters:
  • [ –
    {
    “id”: “blob_id”,

    }, {

    ”id”: “blob_id”,

    }

  • ] –
  • request – HTTP request
Returns:

204

content: Deletion succeed

  • code: 400 content: Validation error
  • code: 403 content: Authentication error
  • code: 500 content: Internal server error
Return type:

  • code
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)
class rest.blob.views.BlobDetail(**kwargs)

Bases: rest_framework.views.APIView

Retrieve, update or delete a Blob

delete(request, pk)

Delete Blob

Parameters:
  • request – HTTP request
  • pk – ObjectId
Returns:

204

content: Deletion succeed

  • code: 403 content: Authentication error
  • code: 404 content: Object was not found
  • code: 500 content: Internal server error
Return type:

  • code
get(request, pk)

Retrieve Blob

Parameters:
  • request – HTTP request
  • pk – ObjectId
Returns:

200

content: Blob

  • code: 404 content: Object was not found
  • code: 500 content: Internal server error
Return type:

  • code
get_object(pk)

Get Blob from db

Parameters:pk – ObjectId
Returns:Blob
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)
class rest.blob.views.BlobDownload(**kwargs)

Bases: rest_framework.views.APIView

Download Blob

get(request, pk)

Download the Blob file

Parameters:
  • request – HTTP request
  • pk – ObjectId
Returns:

200

content: Blob file

  • code: 404 content: Object was not found
  • code: 500 content: Internal server error
Return type:

  • code
get_object(pk)

Get Blob from db

Parameters:pk – ObjectId
Returns:Blob
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)
class rest.blob.views.BlobList(**kwargs)

Bases: rest_framework.views.APIView

List all user Blob, or create a new one

get(request)

Get all user Blob

Url Parameters:

filename: document_filename

Examples

../blob/ ../blob?filename=[filename]

Parameters:request – HTTP request
Returns:
200
content: List of blob
  • code: 500 content: Internal server error
Return type:
  • code
permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)
post(request)

Create Blob

Parameters:
  • { – “blob”: “[file]”,
  • } –

Code snippet:

requests.post(url, files={‘blob’: open(BLOB_PATH, ‘rb’)}, auth=(USER, PSWD))
Parameters:request – HTTP request
Returns:
200
content: Created blob
  • code: 400 content: Validation error
  • code: 500 content: Internal server error
Return type:
  • code