Metadata 22.1
MediaHaven has a wide variety of metadata fields. This table list various information about these fields.
Legend
Key / Sub Key: The name of the field as it appears the metadata XML and JSON
Format: extra information about the format of the value, see Metadata Concepts for more information about the used terms
Read-only: This field cannot be modified in the user interface or API calls
Search: When performing a search query APIs you must use the flattened key, for example
+Title:"Breaking News!" +KeywordsKeyword:PoliticsSearchable: In the MediaHaven REST API you can search and sort on this field
Descriptive Fields
Descriptive fields are modifiable fields that describe files for purposes such as discovery.
Key | Sub Key | Description | Format | Read-only | Search |
|---|---|---|---|---|---|
|
| The title of the file |
|
| |
|
| Description about the file |
|
| |
|
| The date and time the file was originally created |
|
| |
|
| The name of the (copyright) owner of the file |
|
|
|
|
| A description about how the file can or can not be disseminated. |
|
|
|
|
| Series of keywords about the file |
|
|
|
|
| Sub field of |
|
| |
|
| Series of categories about the file |
|
|
|
|
| Sub field of |
|
| |
|
| Publisher of the file |
|
|
|
|
| A list of various authors of the file |
|
|
|
|
| Sub field of |
|
| |
|
| List of locations where the file is published |
|
|
|
|
| Sub field of |
|
|
|
|
| The name of the file as it was ingested into MediaHaven |
|
| |
|
| The relative path of the file to the watchfolder or archive was ingested into MediaHaven |
|
|
|
|
| The name of the user that uploaded the file |
|
| |
| By default the the field | frames (using a fictitious 25 fps) |
|
LimitedCategories
Key | Sub Key | Sub Key #2 | Description | Format | Read-only | Search |
|---|---|---|---|---|---|---|
|
|
| List of categories linked with the record |
|
|
|
|
|
| A single category which corresponds with a concept in the thesaurus |
|
|
|
|
|
|
|
|
| |
|
|
| Dutch label of the concept |
|
|
|
|
|
| English label of the concept |
|
|
|
|
|
| French label of the concept |
|
|
|
|
|
| German label of the concept |
|
|
|
Position
Key | Sub Key | Description | Format / Example | Read-only | Search |
|---|---|---|---|---|---|
|
| Number of edit units to skip at the start of the source video codec before the logical of start of the essence |
|
|
|
|
|
| latitude,longitude
|
| |
|
|
|
|
|
|
|
| The country part of the translated |
|
| |
|
| The area part of the translated |
|
| |
|
| The sub area part of the translated |
|
| |
|
| The postal code part of the translated |
|
| |
|
| The locality / city / council part of the translated |
|
| |
|
| The sub locality / city / council part of the translated |
|
| |
|
| The street part of the translated |
|
| |
|
| The house number part of the translated |
|
|
Administrative Fields
Administrative Fields are human readable read-only fields which are used for managing and preserving files in MediaHaven.
Key | Description | Format | Read-only | Search |
|---|---|---|---|---|
| The name of the organisation to which the file belongs |
| ||
| The date and time when the file was last modified by any user, including by the system under the hood |
| ||
| The date and time when the file was last edited by non system user. System users are used by process and customer support users. |
| ||
| The ID of the file in an external platform. This field is only for advanced installations. |
| ||
| The date and time the file was ingested |
| ||
| The type of the file (e.g. image, document, page, image, layer, newspaperpage, article, video, videofragment, audio, audiofragment, set, collection, newspaper, metadataonly) |
| ||
| The name of the department that published the file |
| ||
| Describes through which workflow a file was ingested (if applicable) |
| ||
| Describes on which ingest tape the file was provided (if applicable) |
| ||
| Indicates whether or not this file or fragment has been synchronized from another MediaHaven. | 0 or 1 | ||
| When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven. | URL |
| |
| Indicates if the file is an original file | 0 or 1 | ||
| Indicates if the file is valid for preservation means | 0 or 1 | ||
| Indicates if the file is valid for access means | 0 or 1 | ||
| The type of the record. |
| ||
| The status of the record (e.g. but not limited to New or Published) |
| ||
| External id of the organisation to which the file belongs. |
|
| |
| The full name of an organisation including white space and punctuation |
| ||
| The date and time the file was published |
|
| |
| Indicates if the record is deleted, and if so whether it’s been deleted logically or permanently. |
|
| |
| The time the record was logically deleted. |
|
|
|
| The date and time the record was rejected. |
|
|
|
ChildOrderFields
Key | Sub Key | Sub Key #2 | Description | Format | Read-only | Search |
|---|---|---|---|---|---|---|
|
|
| The sort order the children of the record should be retrieved in. |
|
|
|
|
|
| A single sort field. |
|
|
|
|
|
| The dotted key of a sortable field definition. |
|
|
|
|
|
| The direction to sort the fields in. Possible values are:
|
|
|
|
Technical Fields
Technical fields are predominantly read-only fields whose values are inherent to data file itself. (Re)-ingesting the file, possibly in a different MediaHaven, will result in exactly the same values.
Common
Key | Description | Format | Read-only | Search | Since |
|---|---|---|---|---|---|
| The extension of the file as it was ingested into MediaHaven |
|