General Resource Uniform Resource Identifier (URI)
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v4/video_groups/[FW_ID]?[parameter1]=[query1]&... |
Note
The Update Child Video Relations endpoint has been deprecated. There is no active development on it and no feature requests can be made. It will soon be removed, at which time it will no longer function nor be supported.
Attributes
| Name | Type | Description | Creatable? | Updatable? | Validations |
|---|---|---|---|---|---|
| id | FW_ID | ID of the Video Group in FreeWheel | No | No | |
| network_id | Integer | ID of the Video Group's network | No | No | |
| name | String | The name of the Video Group | Req | Yes | Unique |
| external_id | String | The Video Group's External ID | Yes | Yes | |
| description | String | Description of the Video Group | Yes | Yes | |
| customized_metadata | Custom Data Type 2 | Custom metadata for the Video Group | Yes | Yes | |
| vod_metadata | String | VOD metadata | Yes | Yes | |
| metadata | String | Video Group metadata | Yes | Yes | |
| status |
Must be provided in ALL CAPITAL letters. | Video Group status | Yes | Yes | |
| updated_at | DateTime | Last updated time | No | No | |
| created_at | DateTime | Created time | No | No |
Custom Data Type 2: customized_metadata
| Name | Type | Creatable? | Updatable? | Validations |
|---|---|---|---|---|
| key | String | Yes | Yes | Unique |
| value | String | Yes | Yes |
JSON Sample Request
{
"customized_metadata":{
"key1":"value1",
"key2":"value2"
}
}
XML Sample Request
<video_group>
...
<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_group>