General Notes
- All paths are relative to the REST endpoint base (something like http://your.server/files)
- If you notice that this service is not working as expected, there might be a bug! You should file an error report with your server logs from the time when the error occurred: Opencast Issue Tracker
Table of Contents
- GET /{mediaPackageId}/assets/storageClass
- GET /glacier/{mediaPackageId}/assets
- PUT /{mediaPackageId}/assets
- PUT /glacier/{mediaPackageId}/assets
Read methods
| Method / Path: | GET /{mediaPackageId}/assets/storageClass |
|---|---|
| Description: | Get the S3 Storage Class for each asset in the Media Package |
| Path params: | mediaPackageId: The media package indentifier. |
| Optional (query) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
200: OK, mediapackage found in S3 404: Not Found, mediapackage not found or has no assets in S3 |
| Notes: |
|
| Testing: |
Sample:
/{mediaPackageId}/assets/storageClass
Testing form (click to reveal)
|
| Method / Path: | GET /glacier/{mediaPackageId}/assets |
|---|---|
| Description: | Get the mediapackage asset's restored status |
| Path params: | mediaPackageId: The media package indentifier. |
| Optional (query) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
200: OK, mediapackage found in S3 and assets in Glacier 204: No Content, mediapackage found in S3 but no assets in Glacier 404: Not Found, mediapackage not found or has no assets in S3 |
| Notes: |
|
| Testing: |
Sample:
/glacier/{mediaPackageId}/assets
Testing form (click to reveal)
|
Write methods
| Method / Path: | PUT /{mediaPackageId}/assets |
|---|---|
| Description: | Move the Media Package assets to the specified S3 Storage Class if possible |
| Path params: | mediaPackageId: The media package indentifier. |
| Required (form) params: | storageClass: The S3 storage class, valid terms STANDARD, STANDARD_IA, INTELLIGENT_TIERING, ONEZONE_IA,GLACIER_IR, GLACIER, and DEEP_ARCHIVE. See https://aws.amazon.com/s3/storage-classes/ |
| Optional (form) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
200: OK, mediapackage found in S3 404: Not Found, mediapackage not found or has no assets in S3 |
| Notes: |
|
| Testing: |
Sample:
/{mediaPackageId}/assets
Testing form (click to reveal)
|
| Method / Path: | PUT /glacier/{mediaPackageId}/assets |
|---|---|
| Description: | Initiate the restore of any assets in Glacier storage class |
| Path params: | mediaPackageId: The media package indentifier. |
| Optional (form) params: | restorePeriod(Default value=2): Number of days to restore the assets for, default see service configuration |
| Response formats: | text/plain |
| Status codes: |
204: No Content, restore of assets started 400: Bad Request, invalid restore period, must be greater than zero 404: Not Found, mediapackage not found or has no assets in S3 |
| Notes: |
|
| Testing: |
Sample:
/glacier/{mediaPackageId}/assets
Testing form (click to reveal)
|