v1/requests

GET /v1/requests

List all requests. No pagination is provided in this version.

Request Headers:  

• Authorization – Bearer token

Response Headers:  

• Content-Type – application/json

Response JSON Object:  

• bag_id (uuid) – bag’s id
• user (string) – Owning user’s username
• content_type (enum) – The content type of the object.
• external_id (string) – The package’s id in its external service
• upload_link (url) – Rsync link client should use to upload package
• storage_location (filepath) – The location of the package on disk. This field is only shown to admins.
• stored (boolean) – Whether the package has been stored for preservation.
• created_at (date) – Datetime when the object was created
• updated_at (date) – Datetime when the object was last changed

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated

POST /v1/requests

Create a new request. Admins may specify the user. For regular users, this field is ignored.

Request Headers:  

• Authorization – Bearer token

Request JSON Object:  

• bag_id (uuid) – bag’s id
• content_type (enum) – The content type of the object.
• external_id (string) – The package’s id in its external service

Response Headers:  

• Content-Type – application/json
• Location – The location of the resource, /requests/(uuid:bag_id)

Status Codes:

• 201 Created – Includes Location header with url to resource, /requests/bag_id.
• 303 See Other – The result of a duplicate request. Includes location header as with 201.
• 401 Unauthorized – Unauthenticated
• 422 Unprocessable Entity – Malformed POST body

GET /v1/requests/(uuid: bag_id)

Show a specific request

Request Headers:  

• Authorization – Bearer token

Parameters:

• bag_id (uuid) – Bag’s id

Response Headers:  

• Content-Type – application/json

Response JSON Object:  

• bag_id (uuid) – bag’s id
• user (string) – Owning user’s username
• content_type (enum) – The content type of the object.
• external_id (string) – The package’s id in its external service
• upload_link (url) – Rsync link client should use to upload package
• storage_location (filepath) – The location of the bag on disk. This field is only shown to admins.
• stored (boolean) – Whether the package has been stored for preservation.
• files (array) – The list of files in the bag.
• created_at (date) – Datetime when the object was created
• updated_at (date) – Datetime when the object was last changed

Status Codes:

• 200 OK – Success
• 401 Unauthorized – Unauthenticated
• 403 Forbidden – User does not own the request, and is not an admin.
• 404 Not Found – Not found

POST /v1/requests/(uuid: bag_id)/complete

Notify the server that a request’s upload has been completed. :reqheader Authorization: Bearer token

Parameters:

• bag_id (uuid) – Bag’s id

Response Headers:  

• Content-Type – application/json
• Location – The location of the resource, /queue/(id)

Status Codes:

• 201 Created – Includes Location header
• 303 See Other – The result of a duplicate request. Includes location header as with 201.
• 401 Unauthorized – Unauthenticated
• 422 Unprocessable Entity – Malformed POST body