Upload Supplemental Files
This endpoint uploads one or more supplemental files to associate with a specified video. Typical file types include PowerPoint and PDF documents that provide a viewer with additional information.
Supported file types are listed below and are also found in Rev’s Online help documentation in the Technical Requirements section.
Path Parameters
| Parameter | Type | Validations |
|---|---|---|
| videoId | string, required | ID of the video to upload and attach supplemental file(s) to |
Request Body
REQUEST: Post Supplemental Files
curl -X POST https://myRevURL.demo.portal.vbrick.com/api/uploads/supplemental-files/f63b69c8-3646-4350-a8e7-df263aa96f9f \
-H 'Authorization: VBrick jCqpQawR1fY6PIOw5avvI-qMrB9b7pPU81EK5xkI_8g-DFUhfoaVFNWV1LfUWxyeBv5mlyLRo04Lz3FPgIgMlg4TypcNQlqj9oU0SqJg3TWMPtFoG-AHi-8s0fftqsNbVcVhqR8KwcoU78E0KhgFgg2' \
-H 'Cache-Control: no-cache' \
-H 'Postman-Token: be1e803c-84e2-4608-a9b3-37e83ff8e039' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
-F '=@C:\Doug\Samples\Sample.docx' \
-F 'SupplementalFiles={
"files": [
{
"fileName": "myFile.docx"
}
]
}'
| Parameter | Type | Validations |
|---|---|---|
| files | multipart/form-data, required |
The supplemental files to upload and associate to the video. Must be a Rev accepted supplemental file type. The filename should be a string with the correct extension. File types include:
You must also provide the Content-Type header for the uploaded file. |
| SupplementalFiles[ ] | files[{fileName}], string, optional | Data object of supplemental file details attached to the video. Multiple files can be assigned. Includes fileName string. |
Response Body
successful response
Unauthorized error
Internal server error
Errors may include:
- MalformedRequest = “Bad request format. Please check your request.”;
- FileNotSupported = “Sorry! Cannot upload this file type.”;
- FileNotSent = “The video file was not uploaded.”;
- UserNotProvided = “Unable to upload video. Please ensure that video is associated to a valid user.”;
- UserDoesNotExist = “Unable to upload video. Please ensure that video is associated to a valid user.”;
- InternalServerError = “Unable to process request at this time. Please try again later.”