Video Metadata

This will retrieve all the various settings and metadata for a specific video.

NOTES:

  • As of Rev v7.15, expirationDate and expirationAction are included in the API response.
  • As of Rev v7.15, “Teams” is an option within VideoAccessControl. When Teams is the access control option, the Teams will also be listed.
  • As of Rev v7.22, is360 will specify if the video returned is a 360-video with a true/false value.
GET
/api/v1/videos/{videoId}/details

Request Parameters

Name Type Description Required
videoId path GUID for the video Yes

Example Response

 
{
    "id": "a44e2dd3-cf05-48f5-8e6c-ed3f6b00f890",
    "title": "Animation",
    "description": "60 Hours of Animation in 20 seconds",
    "htmlDescription": "60 Hours of Animation in 20 seconds",
    "linkedUrl": {
        "url": "http://172.22.164.32:80/rev_Royals1/Royals1/playlist.m3u8",
        "encodingType": "H264",
        "type": "Live",
        "isMulticast": true,
        "is360": false
    },
    "categories": [
        "28d90b09-2cae-43ac-bd5a-33fd7ae7fe83"
    ],
    "tags": [
        "School",
        "Knowledge"
    ],
    "isActive": true,
    "expirationDate": "2020-04-20",
    "publishDate": null,
    "approvalStatus": "Approved",
    "enableRatings": true,
    "enableDownloads": false,
    "enableComments": true,
    "videoAccessControl": "Private",
    "accessControlEntities": [
        {
            "id": "9140f73e-402d-4d96-9aee-bd98fe9a6b40",
            "name": "richscott",
            "type": "User",
            "canEdit": true
        }
    ],
    "password": null,
    "canEdit": true,
    "status": "Ready",
    "thumbnailUrl": "https://myRev.rev-eu.demo.vbrick.com/api/v1/media/videos/thumbnails/38ed2ca6-557a-48c9-9be4-38f0828af043.jpg",
    "uploadedBy": "Doug Uhl",
    "whenUploaded": "2018-04-20T20:40:27.346Z",
    "customFields": [
        {
            "id": "b85fdd4f-aec1-4b6b-9b35-541504a2a115",
            "name": "Custom1",
            "value": "Test",
            "required": false,
            "displayedToUsers": true,
            "fieldType": "Text"
        },
        {
            "id": "e1413e72-3611-4522-bf2f-353132834bc8",
            "name": "Custom2",
            "value": "Yes",
            "required": false,
            "displayedToUsers": false,
            "fieldType": "Select"
        }
    ],
    "categoryPaths": [
        {
            "categoryId": "28d90b09-2cae-43ac-bd5a-33fd7ae7fe83",
            "name": "HR",
            "fullPath": "HR"
        }
    ],
    "sourceType": "REV",
    "expirationAction": "Delete"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

 

Example – curl

REQUEST: Get Video Details

curl -X POST https://doug.rev-eu.demo.vbrick.com/api/v1/videos/a44e2dd3-cf05-48f5-8e6c-ed3f6b00f890/details \
  -H 'Authorization: VBrick e0LoDDh9VIZaJCXUXib3NUPRnqBetqScyDFG2ccXK1DBt7q_nZAWFCY24EmZo4I_VoTA44mfwBf5kO-fa70wpUwUeqGTSqC5CAmDlEIruPMtpciLmpG6x7lrpDECXKgVpGPnEDwVxgSOj4sn4LDTdg2' \
  -H 'Cache-Control: no-cache' \
  -H 'Postman-Token: 08338d3c-e7e0-40df-905b-990894e336a7'

Video Status

This will retrieve the current status for a specific video. Possible status values for transient state while upload is in progress:

  • NotUploaded
  • Uploading
  • UploadingFinished
  • Ingesting
  • Processing

Possible status values for final state once upload has completed:

  • Canceled
  • UploadFailed
  • ProcessingFailed
  • Ready
GET
/api/v1/videos/{videoId}/status

Request Parameters

Name Type Description Required
videoId path GUID for the video Yes

Example Response

 
{
    "videoId": "b9a38810-cd84-480c-8232-5ec6320a6b47",
    "title": "Video Title",
    "status": "Ready",
    "isActive": true,
    "uploadedBy": "Mark",
    "whenUploaded": "2015-02-26T15:53:12.406Z"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Example – curl

REQUEST: Get Video Status

curl -X GET \
https://REVURL/api/v1/videos/f63b69c8-3646-4350-a8e7-df263aa96f9f/status \
-H 'Authorization: VBrick EYmIJUI-ia6_xLGY4MoC6LvoHG45y5xuJJ9wVgA4rheZTztQpJIAHdXrivqcYWKiJqPIS39WwHUpQY4OMwNU4N2g5b-Hf5JVa7OCcON04Zwvf3LGrtQVg34-AxbIG3Ft5YTcvFQqGLIL4auFA-sXEw2' \
-H 'Cache-Control: no-cache' \
-H 'Postman-Token: 621cedd7-fc8f-424d-8138-61a66da69b3a'

Video Playback URL

This will retrieve a playback URL and thumbnail URL for a specific video. The playback URL is used for embed code purposes and is NOT a direct link to the video file.

GET
/api/v1/videos/{videoId}/playback-url

Request Parameters

Name Type Description Required
videoId path GUID for the video Yes

Example Response

 
{
  "video":
  {
    "id": "03080959-10d8-47f2-9119-7f516ca8d00b",
    "title": "Animation",
    "description": "60 Hours of Animation in 20 seconds",
    "categories": [
    {
      "categoryId": "47c36208-42e5-48b8-8def-a0779f3de196",
      "name": "Education",
      "fullPath": "Education"
    },
    {
      "categoryId": "2d1ea902-fe96-4031-aef0-5af800d95fe4",
      "name": "Schools",
      "fullPath": "Schools"
    } ],
    "tags": [ "Animated", "Robot" ],
    "thumbnailUrl": "http://RevUrl/media/videos/thumbnails/a9c75889-4204-44d4-8182-cac5e2899eac.jpg",
    "playbackUrl": "http://RevUrl/embed?id=03080959-10d8-47f2-9119-7f516ca8d00b"
  }
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error