Overview
Content metadata can be edited using the REST API located at /content_api
Request URL
/content_api/[id]/edit?program_code=[program_code]&program=[program]&episode_code=[episode_code]&episode=[episode]&description=[description]&duration=[duration]&filename=[filename]&location=[location]&contributor=[contributor]&ingested_at=[XXXX-MM-DD]&deleted_at=[XXXX-MM-DD]&categories[]=[category]&custom_metadata[key]=[value]&api_key=[api key]
Ex. http://myserver:80/content_api/452/edit?program_code=01&program=a1test&episode_code=009&episode=e1&description=mydescription&duration=30&filename=AAx&location=here&contributor=mycontrib&ingested_at=2011-04-20&deleted_at=2012-04-20&categories[]=Community&categories[]=Sports&custom_metadata[foo]=bar& api_key=f1815f1f2011e32b6309
api_key is generated on the users tab which is accessible from the config tab.
Parameters
| Parameter | Type | Required | Max Length | Description |
|---|---|---|---|---|
id |
Integer |
 |
The id of the content file to edit. | |
program_code |
String |
64 | The content file’s program code. If this is an unattached content file (no physical file yet) that is part of a sequence then either program or program_code is required depending on the “Use program and episode codes” configuration setting. The same applies to episode or episode code | |
program |
String |
254 | The content file’s program code. If this is an unattached content file (no physical file yet) that is part of a sequence then either program or program_code is required depending on the “Use program and episode codes” configuration setting | |
episode_code |
String |
64 | The content file’s episode code. If this is an unattached content file (no physical file yet) that is part of a sequence then either episode or episode_code is required depending on the “Use program and episode codes” configuration setting | |
episode |
String |
254 | The content file’s episode. If this is an unattached content file (no physical file yet) that is part of a sequence then either episode or episode_code is required depending on the “Use program and episode codes” configuration setting | |
short_summary |
String |
255 | The content file’s short summary. | |
description |
String |
The content file’s description. Can be any valid block of text | ||
duration |
Integer |
The content duration in seconds. If this is an unattached content file, must be greater than 0. This may be less than the actual content duration for virtual trimming purposes. Replaced the legacy parameter named expected_duration. | ||
offset |
Integer |
An offset into the content in seconds for virtual trimming purposes. The offset plus the duration should not be greater than actual content duration. | ||
filename |
String |
255 | If this is an unattached content file, must be specified. Replaced the legacy parameter named expected_filename. | |
location |
String |
32 | If this is an unattached content file, must be specified if the system is configured to require location for unattached content | |
contributor |
String |
64 | ||
ingested_at |
Date/Time |
Must be a valid ISO date/time. Replaced the legacy parameter named import_datetime. | ||
deleted_at |
Date/Time |
Must be a valid ISO date/time. Replaced the legacy parameter named delete_datetime. | ||
api_key |
String |
|
Must be a valid api key | |
categories |
Array |
A list of categories to add this content to. They must already exist on the system. | ||
| custom metadata | Hash |
A hash of custom metadata keys and values to update for this content file. They must already exist on the system. |
Code Examples
See URL example above.
Return
The success status of the operation will be output onto the screen. ‘true’ for success and ‘false’ for an error or invalid data.
