HomeAboutasset/$asset_id

asset/$asset_id

25Sep2009 Posted by forgacs

Getting an asset details

This call gives back the details of an asset with a metadata.

Request URL

/asset/{asset_id} [GET]

Request parameters

Parameter

Type

Description

Method

Obligatory/Optional

asset_id

alphanumeric

the asset getting the information from

URL

obligatory

user_id, aut_user_id

string

The current user is used for authorization. The aut_* fields affect the [granted] field in the output, and the parameter "granted" was given the number of records.

GET

obligatory

aut_group_id, aut_group_id[]

string

The group(s), where the current user is in, is used for authorization

GET

optional

aut_domain

string

The domain of the user for autohorisation

GET

optional

aut_realm

string

The realm of the user for autohorisation

GET

optional

show_stills

boolean

If it is true, then it shows all of the still informations. Default TRUE

GET

optional

Example request URL

/asset/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z

Example response

  <items>
    <item id="1">
      <asset_id>M9FyEFTVy0zFzpbOv7DaEH4U</asset_id>
      <app_id>4</app_id>
      <provider_id></provider_id>
      <owner_id>owner</owner_id>
      <group_id></group_id>
      <videotimestamp>2009-06-11 16:07:38</videotimestamp>
      <videotimestampmodified>2009-09-23 14:40:54</videotimestampmodified>
      <play_restriction_start></play_restriction_start>
      <play_restriction_end></play_restriction_end>
      <locked>FALSE</locked>
      <reference_id></reference_id>
      <isprivate>FALSE</isprivate>
      <mediafile_duration>00:00:45.7</mediafile_duration>
      <mediafile_container_type>asf</mediafile_container_type>
      <is_unappropiate>FALSE</is_unappropiate>
      <is_external>FALSE</is_external>
      <viewed>1631</viewed>
      <played>97</played>
      <is_empty_asset>FALSE</is_empty_asset>
      <is_protected>DOMAIN_REALM</is_protected>
      <has_streamable_mediafiles>FALSE</has_streamable_mediafiles>
      <dublin_core>
        <type></type>
        <format></format>
        <language>nl</language>
        <title>Test title</title>
        <creator></creator>
        <publisher></publisher>
        <subject></subject>
        <description>Test description</description>
        <contributor></contributor>
        <date></date>
        <identifier></identifier>
        <source></source>
        <relation></relation>
        <coverage_temporal></coverage_temporal>
        <coverage_spatial></coverage_spatial>
        <rights></rights>
      </dublin_core>
      <qualified_dublin_core>
        <title_alternative></title_alternative>
        <description_abstract></description_abstract>
        <created></created>
        <issued></issued>
        <hasformat></hasformat>
        <isformatof></isformatof>
        <format_medium></format_medium>
        <format_extent></format_extent>
        <license></license>
        <rightsholder></rightsholder>
        <isreferencedby></isreferencedby>
      </qualified_dublin_core>
      <czp>
        <schemanaam>http://your_wle/</schemanaam>
        <identificatiecode>http://your_wle/asset/M9FyEFTVy0zFzpbOv7DaEH4U</identificatiecode>
        <titel></titel>
        <taal></taal>
        <beschrijving></beschrijving>
        <sleutelwoord></sleutelwoord>
        <aggregatieniveau>niveau</aggregatieniveau>
        <versie>x</versie>
        <status>final</status>
        <soort_leermateriaal>Evaluatie- en toetsmateriaal</soort_leermateriaal>
        <beoogde_eindgebruiker>Auteur</beoogde_eindgebruiker>
        <context>VVE</context>
        <beoogde_leeftijdsgroep></beoogde_leeftijdsgroep>
        <kosten>nee</kosten>
        <auteursrechten>Ja</auteursrechten>
        <omschrijving_rechten>x</omschrijving_rechten>
        <classificatie>x</classificatie>
      </czp>
      <ega_view_url>http://your_ega_view_url/viewasset/M9FyEFTVy0zFzpbOv7DaEH4U</ega_view_url>
      <is_favorite>FALSE</is_favorite>
      <granted>TRUE</granted>
      <vpx_still_url>http://your_vpx/still/Em4fKZU6iiKuuWrgbcQ86vPR</vpx_still_url>
      <ega_still_url>http://your_still_url/M9FyEFTVy0zFzpbOv7DaEH4U</ega_still_url>
      <mediafiles>
        <mediafile id="1">
          <mediafile_id>9PIxRij3YGRgenkyjwOT7zyS</mediafile_id>
          <asset_id>M9FyEFTVy0zFzpbOv7DaEH4U</asset_id>
          <app_id>4</app_id>
          <owner_id>owner</owner_id>
          <group_id></group_id>
          <is_original_file>TRUE</is_original_file>
          <is_downloadable>FALSE</is_downloadable>
          <filename>testfilename.wmv</filename>
          <uri></uri>
          <transcode_profile_id></transcode_profile_id>
          <tool></tool>
          <command></command>
          <file_extension></file_extension>
          <is_protected>FALSE</is_protected>
          <created>2009-09-22 14:42:03</created>
          <changed>2009-09-23 14:40:02</changed>
          <transcode_inherits_acl>FALSE</transcode_inherits_acl>
          <mediafile_source></mediafile_source>
          <tag>test</tag>
          <is_streamable>FALSE</is_streamable>
          <is_still>FALSE</is_still>
          <metadata>
            <video_codec>wmv3</video_codec>
            <colorspace>yuv420p</colorspace>
            <width>384</width>
            <height>288</height>
            <fps>25</fps>
            <audio_codec>wmav2</audio_codec>
            <sample_rate>44100</sample_rate>
            <channels>2</channels>
            <file_duration>00:00:45.7</file_duration>
            <container_type>asf</container_type>
            <bitrate>1023</bitrate>
            <bpp>0.37</bpp>
            <filesize>5851382</filesize>
            <mime_type>video/x-ms-asf</mime_type>
            <created>2009-10-12 16:48:33</created>
            <changed>2009-10-12 16:48:33</changed>
            <is_hinted>FALSE</is_hinted>
            <is_inserted_md>FALSE</is_inserted_md>
          </metadata>
          <ega_download_url></ega_download_url>
          <ega_play_url>http://your_ega_play_url/play/M9FyEFTVy0zFzpbOv7DaEH4U/9PIxRij3YGRgenkyjwOT7zyS/19697</ega_play_url>
          <ega_stream_url>http://your_stream_url/M9FyEFTVy0zFzpbOv7DaEH4U/9PIxRij3YGRgenkyjwOT7zyS/19697</ega_stream_url>
        </mediafile>
        <mediafile id="2">
          <mediafile_id>2vi8R0dDLXyCKE3vC6qYL2bG</mediafile_id>
          <asset_id>M9FyEFTVy0zFzpbOv7DaEH4U</asset_id>
          <app_id>4</app_id>
          <owner_id>owner</owner_id>
          <group_id></group_id>
          <is_original_file>FALSE</is_original_file>
          <is_downloadable>FALSE</is_downloadable>
          <filename>testvideo.flv</filename>
          <uri></uri>
          <transcode_profile_id>2</transcode_profile_id>
          <tool>ffmpeg</tool>
          <command>videobitrate:200000;size:320x240;audiosamplingrate:22050;maintain_aspect_ratio:yes</command>
          <file_extension>flv</file_extension>
          <is_protected>FALSE</is_protected>
          <created>2009-09-22 14:42:30</created>
          <changed>2009-09-22 15:19:49</changed>
          <transcode_inherits_acl>FALSE</transcode_inherits_acl>
          <mediafile_source></mediafile_source>
          <tag>transcoded</tag>
          <is_streamable>FALSE</is_streamable>
          <is_still>FALSE</is_still>
          <metadata>
            <video_codec>flv</video_codec>
            <colorspace>yuv420p</colorspace>
            <width>320</width>
            <height>240</height>
            <fps>25</fps>
            <audio_codec>mp3</audio_codec>
            <sample_rate>22050</sample_rate>
            <channels>1</channels>
            <file_duration>00:00:45.6</file_duration>
            <container_type>flv</container_type>
            <bitrate>200</bitrate>
            <bpp>0.1</bpp>
            <filesize>1828989</filesize>
            <mime_type>video/x-flv</mime_type>
            <created>2009-10-12 16:48:33</created>
            <changed>2009-10-12 16:48:33</changed>
            <is_hinted>FALSE</is_hinted>
            <is_inserted_md>TRUE</is_inserted_md>
          </metadata>
          <ega_download_url></ega_download_url>
          <ega_play_url>http://your_ega_play_url/play/M9FyEFTVy0zFzpbOv7DaEH4U/2vi8R0dDLXyCKE3vC6qYL2bG/19697.flv</ega_play_url>
          <ega_stream_url>http://your_stream_url/M9FyEFTVy0zFzpbOv7DaEH4U/2vi8R0dDLXyCKE3vC6qYL2bG/19697.flv</ega_stream_url>
        </mediafile>
      </mediafiles>
    </item>
  </items>

Response fields

Field

Description

item

Full description of the asset including the metadata in XML format

asset_id

Asset id

app_id

Application id

provider_id

Provider id

owner_id

Owner id

group_id

Group id

videotimestamp

Timestamp

videotimestampmodified

Timestamp (when it was modified)

play_restriction_start

ISO 8601 datum, YYYY-MM-DD HH:MM:SS

play_restriction_end

ISO 8601 datum, YYYY-MM-DD HH:MM:SS

locked

locked

reference_id

reference_id

isprivate

isprivate

mediafile_duration

The duration of the mediafile (video)

mediafile_container_type

Mime type of the mediafile

is_unappropiate

is_unappropiate

is_external

It is TRUE or FALSE. If it is TRUE, then the mediafile is on an another (external) server

viewed

This parameter shows how many people have viewed this mediafile

played

This parameter shows how many people have played this mediafile

is_empty_asset

This parameter is TRUE or FALSE. Shows whether it is an empty asset or not.

is_protected

This parameter is TRUE or FALSE. Shows whether it is a protected asset or not.

has_streamable_mediafiles

This parameter is TRUE or FALSE. Shows whether it has a streamable mediafile or not.

dublin_core

Dublin Core (see: http://dublincore.org/documents/dces/)

type

 

format

 

language

 

title

 

creator

 

publisher

 

subject

 

description

 

contributor

 

date

 

identifier

 

source

 

relation

 

coverage_temporal

 

coverage_spatial

 

rights

 

qualified_dublin_core

Qualified Dublin Core (see: http://web.resource.org/rss/1.0/modules/dcterms/)

title_alternative

 

description_abstract

 

created

 

issued

 

hasformat

 

isformatof

 

format_medium

 

format_extent

 

license

 

rightsholder

 

isreferencedby

 

czp

CZP metadata format

schemanaam

Asset property

identificatiecode

Asset property

titel

Asset property

taal

Asset property

beschrijving

Asset property

sleutelwoord

Asset property

aggregatieniveau

Asset property

versie

Asset property

status

Asset property

soort_leermateriaal

Asset property

beoogde_eindgebruiker

Asset property

context

Asset property

beoogde_leeftijdsgroep

Asset property

kosten

Asset property

auteursrechten

Asset property

omschrijving_rechten

Asset property

classificatie

Asset property

ega_view_url

ega_view_url

is_favorite

This parameter is TRUE or FALSE. Shows whether it is a favourite asset or not.

granted

Granted

vpx_still_url

VPX Still URL

ega_still_url

Ega still URL

mediafiles

Mediafiles

mediafile_id

The unique mediafile id

asset_id

The id of the asset

app_id

The application id

owner_id

The owner of mediafile

group_id

The group of mediafile

is_original_file

Boolean value. TRUE, if the mediafile is original. If the mediafile - for example - transcoded to an another format (e.g. Flash), this value is FALSE.

is_downloadable

Boolean value. TRUE, if the mediafile is downloadable.

filename

String value with the file name of the mediafile, if there is any

uri

The uri of the mediafile, if the mediafile is external. Otherwise it is empty.

transcode_profile_id

 

tool

 

command

 

file_extension

The extension of the file

is_protected

 

created

 

changed

 

transcode_inherits_acl

 

mediafile_source

 

tag

 

is_streamable

 

is_still

 

still

 

* mediafile_id

 

* asset_id

 

* app_id

 

* owner_id

 

* group_id

 

* is_original_file

 

* is_downloadable

 

* filename

 

* uri

 

* sannas_mount_point

 

* transcode_profile_id

 

* tool

 

* command

 

* file_extension

 

* testtag

 

* is_protected

 

* created

 

* changed

 

* asset_id_root

 

* transcode_inherits_acl

 

* mediafile_source

 

* tag

 

* is_streamable

 

* is_still

 

* metadata_id

 

* video_codec

 

* colorspace

 

* width

 

* height

 

* fps

 

* audio_codec

 

* sample_rate

 

* channels

 

* file_duration

 

* container_type

 

* bitrate

 

* bpp

 

* filesize

 

* mime_type

 

* is_hinted

 

* is_inserted_md

 

* still_time_code

From which seconds of the mediafile was the still made?

* sill_order

The stills are ordered by this number

* still_format

Format of the image (eg. "jpeg")

* still_type

How the still was made? Possible valued: NONE (only one image from the mediafile), NORMAL (x stills per mediafile), SECOND (one still from every x second), SCENE (one still from every scene changes)

* still_default

Is the still is the default image? Only one default image is allowed per asset

* still_ticket

The ticket of the image. You can use it - only once - in the browser, as the picture url

metadata

 

* video_codec

 

* colorspace

 

* width

 

* height

 

* fps

 

* audio_codec

 

* sample_rate

 

* channels

 

* file_duration

 

* container_type

 

* bitrate

 

* bpp

 

* filesize

 

* mime_type

 

* created

 

* changed

 

* is_hinted

 

* is_inserted_md

 

ega_download_url

 

ega_play_url

 

ega_stream_url

 

 

Comments

Response parameters

Posted by Michiel.Schok on October 19th, 2009 - 14:25

I would like to see an overview of all the XML-output parameters, and how the parameters are fetched or computed.
Some parameters can be 'set' like 'is_downloadable', others are computed like 'ega_play_url' on the basis of the transcode_id of a mediafile of this asset, and the preference set in the 'beheeromgeving' of VP-core Client applications.