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)

Environment	URL
Production	`https://api.freewheel.tv/services/v4/videos/{FW_ID}?{parameter1}={query1}&...`

Attributes

Name	Type	Description	Creatable?	Updatable?	Required?
id	FW_ID	ID of the Video in FreeWheel	No	No
network_id	Integer	ID of the Video's network	No	No
external_id	String	The Video's External ID	Yes	Yes	*Note: Must be unique on the network.*
secondary_id	String	The Video's secondary ID	Yes	Yes
description	String	Description for the Video	Yes	Yes
metadata	String	Video metadata	Yes	Yes
actor	String	Actor	Yes	Yes
director	String	Director	Yes	Yes
writer	String	Writer	Yes	Yes
producer	String	Producer	Yes	Yes
fw_contextual_segments	Integer	Contextual Segments Targeted on the Video Asset	Yes	Yes
customized_metadata	Custom Data Type 1	Custom metadata for the Video	Yes	Yes
language	String	Language	Yes	Yes
rating	G PG PG-13 R Mature Unrated	Video rating. Default value is Unrated.	Yes	Yes
title1	String	Title 1	Yes	Yes	Yes
title2	String	Title 2	Yes	Yes
duration	Integer	Video duration	Yes	Yes
season	Integer	Season	Yes	Yes
asset_aging_date	DateTime	Aging date for the Video	Yes	Yes
display_right_start_date	DateTime	Display right start	Yes	Yes
display_right_end_date	DateTime	Display right end	Yes	Yes
air_dates	DateTime	Air dates	Yes	Yes
vod_metadata	String	VOD metadata	Yes	Yes
status	ACTIVE INACTIVE	Video status	Yes	Yes	*Note: These values must be provided in ALL CAPITAL letters.*
updated_at	DateTime	Last updated time	No	No
created_at	DateTime	Created time	No	No

Custom Data Type 1: customized_metadata

Name	Type	Creatable?	Updatable?	Validations	Required?
key	String	Yes	Yes	Unique
value	String	Yes	Yes

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>