Open source media management and distribution platform

asset/$asset_id/metadata

Adding metadata to an asset

Through this call you can add a metadata to an asset. With any modification you must also send all of the old values, otherwise they will be deleted.

Request URL

/asset/{asset_id}/metadata [POST]

Request parameters

Parameter

Type

Description

Method

Obligatory/Optional

asset_id

alphanumeric

the asset that the information has to change

URL

obligatory

user_id

string

user id for autorisation.

POST

obligatory

replace

bool

'TRUE' or 'FALSE'. Default is TRUE. Define 'FALSE' if you want to add the passed parameters and the other (existing) to leave. Note: if a parameter exists, it will not be overwritten.

POST

optional

action

string

Shows how the metadata properties to be used, possible values: 'replace', 'append', 'update'. 'replace' is default. This parameter can not be used in conjunction with the previous parameter: replace.

action = replace: remove all existing metadata properties, and new data are stored.

action = append: all existing metadata properties remain, and new data are stored alongside.

action = update: only the data of the passed property definitions are replaced, not sending properties remain unchanged.

POST

optional

type

string

dublin core

POST

optional

format

string

dublin core

POST

optional

language

ISO 639-1-codes

2-character language code, dublin core

POST

optional

title

string

dublin core

POST

optional

creator

string

dublin core

POST

optional

publisher

string

dublin core

POST

optional

subject

string

dublin core

POST

optional

description

string

dublin core

POST

optional

contributor

string

dublin core

POST

optional

date

ISO 8601 datum/time

YYYY-MM-DD HH:MM:SS, dublin core

POST

optional

identifier

string

dublin core

POST

optional

source

string

dublin core

POST

optional

relation

string

dublin core

POST

optional

coverage_temporal

string

dublin core

POST

optional

coverage_spatial

string

dublin core

POST

optional

rights

string

dublin core

POST

optional

isreferencedby

string

qualified dublin core

POST

optional

title_alternative

string

qualified dublin core

POST

optional

description_abstract

string

qualified dublin core

POST

optional

created

ISO 8601 datum/time

qualified dublin core

POST

optional

issued

ISO 8601 datum/time

qualified dublin core

POST

optional

hasformat

string

qualified dublin core

POST

optional

isformatof

string

qualified dublin core

POST

optional

format_medium

string

qualified dublin core

POST

optional

format_extent

string

qualified dublin core

POST

optional

license

string

qualified dublin core

POST

optional

rightsholder

string

qualified dublin core

POST

optional

...

string

any metadata_tags added with metadata_tag/create

POST

optional

 

Example request URL

This call delete all of the metadata and set the title and the subject:

/asset/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z/metadata?user_id=entree004

POST: title=”Titel”

subject[]=”Subject 1”

subject[]=”Subject 2”

 

And this call adds an extra 'title' and 2 extra 'subjects' to the metadata.

/asset/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z/metadata?user_id=entree004

POST: title=”Titel”

subject[]=”Subject 1”

subject[]=”Subject 2”

replace=FALSE

 

If only the title need to be updated, following the call can be used:

/asset/VlN2ZDKv9rpsfmBAWpvfiw1zQ6z/metadata?user_id=entree004

POST: title=”Nieuwe Titel”

action=”update”

 

Response fields

Field

Description

n/a

This call doesn't return others, just the standard header with the request information