Video API V4

Overview

The Video API V4 provides methods to create, retrieve, and update video assets.

Endpoints are grouped under three categories:

General Resource Uniform Resource Identifier (URI)

EnvironmentURL
Productionhttps://api.freewheel.tv/services/v4/videos/{FW_ID}?{parameter1}={query1}&...

Attributes

NameTypeDescriptionCreatable?Updatable?Required?
idFW_IDID of the Video in FreeWheelNoNo
network_idIntegerID of the Video's networkNoNo
external_idStringThe Video's External IDYesYesNote: Must be unique on the network.
secondary_idStringThe Video's secondary IDYesYes
descriptionStringDescription for the VideoYesYes
metadataStringVideo metadataYesYes
actorStringActorYesYes
directorStringDirectorYesYes
writerStringWriterYesYes
producerStringProducerYesYes
fw_contextual_segmentsIntegerContextual Segments Targeted on the Video AssetYesYes
customized_metadataCustom Data Type 1Custom metadata for the VideoYesYes
languageStringLanguageYesYes
rating
  • G
  • PG
  • PG-13
  • R
  • Mature
  • Unrated
Video rating. Default value is Unrated.YesYes
title1StringTitle 1YesYesYes
title2StringTitle 2YesYes
durationIntegerVideo durationYesYes
seasonIntegerSeasonYesYes
asset_aging_dateDateTimeAging date for the VideoYesYes
display_right_start_dateDateTimeDisplay right startYesYes
display_right_end_dateDateTimeDisplay right endYesYes
air_datesDateTimeAir datesYesYes
vod_metadataStringVOD metadataYesYes
status
  • ACTIVE
  • INACTIVE
Video statusYesYesNote: These values must be provided in ALL CAPITAL letters.
updated_atDateTimeLast updated timeNoNo
created_atDateTimeCreated timeNoNo

Custom Data Type 1: customized_metadata

NameTypeCreatable?Updatable?ValidationsRequired?
keyStringYesYesUnique
valueStringYesYes

JSON Sample Request

{
      "customized_metadata":{
          "key1":"value1",
          "key2":"value2"
      }
  }

XML Sample Request

<video>
  ...
    <customized_metadata>
        <key_value>
            <key>key1</key>
            <value>value1</value>
        </key_value>
        <key_value>
            <key>key2</key>
            <value>value2</value>
        </key_value>
    </customized_metadata>
  </video>