S3 Storage Web Service

 

Web service for S3 file storage

 

 

More information: https://it.byu.edu
Contact Info: api@byu.edu

 

Base URL: /storage/v1

Version: v1

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/file POST

Create a new file

/file/{fileUUID} DELETE

Delete the specified file

GET

Get a file

/heartbeat GET

Web service heatbeat

Paths

Create a new file

POST /file

Save a file to Alfresco and S3. Get back the Alfresco ServerID, which is also the S3 UUID filename.

application/octet-stream

 

the file to be saved

 

 
         
filename

The name of the file

query string  

text/plain

200 OK

Status 200

 
Delete the specified file

DELETE /file/{fileUUID}

Remove the file identifed by the fileUUID (will remove from both Alfresco and S3)

         
fileUUID

The UUID (filename on S3, serverID on Alfresco) of the file

path string  

text/plain

200 OK

Status 200

 
Get a file

GET /file/{fileUUID}

Get a file based on the fileUUID (ServerId in Alfresco, file name in S3)

         
fileUUID

The UUID (filename on S3, serverID on Alfresco) of the file

path string  

application/octet-stream

200 OK

Status 200

 
Web service heatbeat

GET /heartbeat

Simple heartbeat checks to make sure the service is available. Also checks to make sure the S3 bucket is accessible.

text/plain

200 OK

Status 200

 
Service Path: 
/storage/v1
Tags: 

Community

 

Don't see your question listed here? Ask!

Tags