Get Content Metadata by ID (REST)

Overview

The REST Web Service, located at /content_metadata, returns metadata for a file. The REST service results are limited to 1K in size but can reveal a lot of information.

Request URL

http://myserver:3000/content_metadata/152

Parameters

Parameter Type Required Max Length Description
id Integer Y 8 The Content ID of the content file on the server. In the above example URL, 152 is the ID.

The ID parameter can be determined by looking at URL paths in the web application. For example, the following URL from the content details page shows a Program ID of 152:

http://myserver:3000/content/show/152?more=HWTTTT

Return

Success

A typical return is in this example.

< ?xml version="1.0" encoding="UTF-8" ?>
<content -file>  
  <!-- The actual duration of the content in milliseconds. -->
  <actual -duration type="integer">30130</actual>
  <contributor /> <!-- No contributor is listed. -->
  <!-- The date this file was imported onto the server. -->
  <created -at type="datetime">2009-07-29T13:09:47-04:00</created>
  <!-- The content is scheduled for deletion on December 31, 2009 at 6:00 PM.
       If the deletion date were blank, this line would read nil. -->
  <delete -datetime type="datetime">2009-12-31T18:00:00-05:00</delete>
  <!-- The description used in the EPG. -->
  <description>Sample Content for TelVue</description>
  <!-- The content’s runtime, in seconds. -->
  <duration type="integer">31</duration>
  <!-- The episode name.  If the Episode field were blank, this would read
       episode nil= true. -->
  <episode>Premiere</episode>
  <!-- If this content had an episode code it would be displayed here. -->
  <episode -code nil="true" />
  <filename>Sample.m2p</filename> <!-- The content’s actual filename. -->
  <!-- Content ID is 152. -->
  <id type="integer">152</id>
  <import_datetime type="datetime">2009-07-29T13:09:47-04:00</import_datetime>
  <location /> <!-- No location is listed. -->
  <!-- The content’s name, as displayed at the top of the Edit Content and
       Show Content pages. -->
  <name>Sample</name>
  <!-- The program name.  If the Program field were blank, this would read
       program nil = true. -->
  <program>Sample Content</program>
  <!-- If this content had a program code it would be displayed here. -->
  <program -code nil="true" />
  <categories type="array">
    <category>  
      <id type="integer">1</id> <!-- This content is in 1 category. -->
      <name>Community</name> <!-- Content is in the Community category. -->
    </category>
  </categories>
  <!-- This content is on the server, rather than being unattached (TBD). -->
  <attached>true</attached>
</content>

Failure

Program not Found

< ?xml version="1.0" encoding="UTF-8"?>
<content>
  <error>Content with id: 152 does not exist.</error>
</content>
Facebooktwittergoogle_pluslinkedin