v1/packages

GET /v1/packages

List all packages. 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

GET /v1/packages/(uuid: bag_id)

Show a specific package.

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 package 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 package.
• 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 resource, and is not an admin.
• 404 Not Found – Not found

GET /v1/packages/(uuid: bag_id)/events

List all events for the given package. No pagination is provided in this version.

Request Headers:  

• Authorization – Bearer token

Parameters:

• bag_id (uuid) – package’s id

Response Headers:  

• Content-Type – application/json

Response JSON Array of Objects:  

• id (int) – The event’s id
• type (string) – The event’s type.
• executor (string) – The user’s username
• outcome (string) – The result of the invent, whether it succeeded or failed.
• detail (string) – Detailed information about the event.
• date (date) – When the event was created

Status Codes:

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

GET /v1/packages/(uuid: bag_id)/(string: file)

Download a file from a package

Request Headers:  

• Authorization – Bearer token

Parameters:

• bag_id (uuid) – package’s id
• file (string) – Relative path to a file in the package

Response Headers:  

• X-Sendfile –

Status Codes:

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