Metadata 24.3
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:Politics
 ÂSearchable: In the MediaHaven REST API you can search and sort on this field
Changelog
Changes versus Metadata 24.2
New field
Technical.Camera
and its childrenModel
,FocalLength
,ShutterSpeed
,Aperture
,Iso
,WhiteBalance
andFlash
Descriptive Fields
Descriptive fields are modifiable and are 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:
|
|
| Â |
RecordRejections
Key | Sub Key | Sub Key #2 | Description | Format | Read-only | Search | Since |
---|---|---|---|---|---|---|---|
| Â | Â | List of rejections |
| Â | Â |
|
|
| Â | One rejection |
| Â | Â |
|
|
|
| A technical key for the reason of the rejection |
| Â | Â |
|
|
|
| A human readable motivation for the rejection |
| Â | Â |
|
|
|
| The date when the rejection occurred |
| Â | Â |
|
|
|
| The user who rejected the record |
| Â | Â |
|
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 | Â | Â | ||
| The size of the file in bytes | Â | Â | ||
| The MD5 checksum of the file | Â | Â | ||
| The mime type of the file, e.g. image/jpg | Â | Â | ||
| The Pronom ID is a file identification mechanism developed by the National Archives |  |  | ||
| The width of the file | pixels | Â | ||
| The height of the file | pixels | Â | ||
| Width times height, e.g 1920x1080 | pixels times pixels | Â | ||
| The quality of the image |
| Â | ||
| The orientation of the image |
| Â | ||
| Contains all EXIF metadata extracted from the file, see Metadata Harvest & Mining for a non exhaustive list of extracted properties |
|
| Â |
|
| The SHA256 checksum of the file. Not filled in by default. | Â |
|
|
|
Camera
Key | Description | Format | Read-only | Search |
---|---|---|---|---|
| Camera model | Â | ||
| Strength of the camera lens | Â |
| |
| How long the camera was exposed to the light | Â |
| |
| Numerical number expressing the maximum angle captured by the lens / camera |
|
| |
| Describes the current sensitivity of the camera to light |
|
| |
| Indicates the white balance mode set when the image was shot. | Â |
| |
| Whether the flash fired or not in textual format | Â |
|
|
Time codes
Key | Description | Format | Read-only | Search |
---|---|---|---|---|
| The duration of the media file |
| Â | |
| The start time of the media file |
| Â | |
| The end time of the media file |
| Â | |
| The duration of the media file, expressed in frames against a fictitious 25 frames per second, e.g. | frames |  | |
| The start time of the media file, expressed in frames against a fictitious 25 frames per second, e.g. | frames |  | |
| The end time of the media file, expressed in frames against a fictitious 25 frames per second, e.g. | frames |  |
VideoÂ
Key | Description | Format | Read-only | Search |
---|---|---|---|---|
| Description about the video encoding of the file | Â | Â | |
| Frames per second of the video in the file | frames per second (fps) | Â | |
| Average bit rate of the video in the file | bits per second (bps) | Â | |
| Description about the audio encoding of the file | Â | Â | |
| Total number of audio channels in the file, if the file has multiple audio tracks, this is the cumulative sum over all tracks | Â | Â | |
| Sample rate of the first audio track in the file | Hz | Â | |
| Total average bitrate of all audio tracks | bits per second (bps) |  | |
| The amount of audio tracks in the file | Â | Â | |
| Total average bit rate of the container (includes video and audio) | bits per second (bps) | Â |
MXF Video
Key | Description | Format | 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 | frames | Â | |
| File offset to the first partition containing essence | bytes | Â | |
|
| bytes | Â | |
| File offset to the first KLV in the file, typically | bytes |  | |
| Number of frames per edit unit | frames | Â | |
| Number of edit units per second, if | fraction |  | |
| Advanced MXF feature, stored for future usage | fraction | Â |
Internal Fields
Internal fields are read-only metadata fields proper to MediaHaven and often not in a human-readable format opposed to the administrative fields.
Key | Description | Remark | Read-only | Search | Since |
---|---|---|---|---|---|
| Successor of the | 64 characters |
| Â | |
| The unique identifier of the file | 64 characters |
| Â | |
| The unique identifier of the fragment of the file | 96 characters | Â | ||
| Status of the validation and ingest of the file |
| Â | ||
| Status of the creation of the preview of the file |
| Â | ||
| The possible values are documented here: Ingest Monitoring | Â | Â | ||
| The ID of the organisation to which the file belongs to. The administrative field | Â | |||
| The ID of the ingest space the file belongs or belonged to | UUID | Â | ||
| Whether the file still belongs to an ingest space | 0 or 1 | Â | ||
| The user ID of the user that uploaded the file, the administrative field | UUID |  | ||
| uuid of the department the file was published with, the administrative field | UUID |  | ||
| Indicates whether or not the file is the main fragment or non-main fragment (i.e. page of a document, videofragment of a video) | 0 or 1 | Â | Â | |
| Indicates whether or not the the file has a series of keyframes (applicable to documents, multi-page images, video and audio) | 0 or 1 | Â | Â | |
| Indicates whether or not the file has geolocation data associated to it | 0 or 1 | Â | ||
| A list of profiles linked to this record, sorted by record type. Note that Mediahaven 1.0 profiles will not be added to this field. |
| Â | ||
| Profiles that can be used for records of any record type. | Â | Â | ||
| Source URL of the file. Only filled out when | URL |
| Â |
|
| Offset of the record in the database. Records are reindexed in this order. |
|
| ||
| Name of the index in which the record is stored. | Â | Â |
|
Previews
Key | Description | Remark | Read-only |
---|---|---|---|
| Public accessible URI to the high resolution keyframe of the record. | URI | |
| Public accessible URI to the low resolution keyframe of the record. | URI | |
| Public accessible URI to the access representation file. | URI | |
| Public accessible URI to the browse mp4 for videos. Obsolete, use | URI | |
| Public accessible URI to the original representation file. By default this is not available because the original storage is only made public upon request → Direct Downloads. | URI |
BrowsesÂ
Key | Sub Key #1 | Sub Key | Description | Remark | Read-only |
---|---|---|---|---|---|
| Â | Â | List of browse formats generated for the file |
| |
|
| Â | Description of a single browse format of the file |
| |
|
|
| Unique label of this browse format | Â | |
|
|
| Extension of the container of this browse, e.g. jpg, mp4 | Â | |
|
|
| URL to the path containing the files associated with this browse format | Â | |
|
|
| Relative path to the main still image of the file. Prefix with |  | |
|
|
| Relative path to the main still image of the file (thumb version). Prefix with |  | |
|
|
| Relative path to the video preview of the file. Prefix with |  | |
|
|
| File size of the | bytes | |
|
|
| Width of the preview (P | pixels | |
|
|
| Height of the preview (P | pixels | |
|
| ... | All keys available under the item #Video on this same page |  |
DistributionsÂ
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| List of distribution channels where the file has been distributed to |
| |||
|
| Provides information about a single channel in the form of <protocol>:<ID>, e.g. jwplayer:bZZVWxol | protocol:id |
WorkflowsÂ
Key | Sub Key | Sub Key #2 | Description | Remark | Read-only | Search |
---|---|---|---|---|---|---|
| Â | Â | List of tasks active for this record |
| Â | |
|
| Â | Provides information about a single task |
| Â | |
|
|
| Unique ID of this task |
| Â | |
|
|
| Type of task (human readable) |
| ||
|
|
| Type of task |
| ||
|
|
| Name of the process this task belongs to |
| ||
|
|
| The ID of the process this task belongs to |
| ||
|
|
| ID of the assigned user |
| ||
|
|
| Login of the assigned user |
| ||
|
|
| Function necessary to complete this task |
| ||
|
|
| Date on which this task was created |
| ||
|
|
| This task should be completed before this date |
|
Structural FieldsÂ
Structural fields provide how compound files such as collections are put together or how files are related between each other. Three categories exist: Fragments, Ensembles and Relations.
Record Tree
Key | Sub Key | Description | Remark | Read-only | Search | Since |
---|---|---|---|---|---|---|
| Â | Contains the full line of ancestors. More info Record Tree |
|
|
| Â |
|
| Â |
|
|
| Â |
| Â | Contains the titles of the full line of ancestors. |
|
|
| Â |
|
| Â |
|
|
| Â |
| Â | If the record has a parent record, this value contains the |
| Â | ||
| Â | If record has or had children in at least one point in time this will field be forever |
| Â | ||
| Â | Refers to the original representation, see Record Tree Glossary | Terms: Representation Forms. |
| Â |
| |
| Â |
|
| Â | Â | |
| Â | Sort order for children of intellectual objects |
Starts from 1 | Â | Â |
|
| Â | The structure of the record type. |
|
|
|
|
| Â | If record has or had at least one child with a record type other than |
|
|
|
|
| Â | Refers for an access / original representation to the data record they belong to |
|
|
|
|
Fragments
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| Â | Series of fragments belonging to this file. The main fragment which corresponds to the file itself (i.e. the entire video) is non contained in this series, hence this list is empty if the file contains no pure (= non main) fragments. |
| Â | |
|
| Sub field of |
| Â | |
|  | For a pure fragment, this refers the |
| Â | |
| Â | The start time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second | frames | Â | |
| Â | The end time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second | frames | Â | |
| Â | The duration of a fragment, expressed in frames against a fictitious 25 frames per second | frames | Â | |
| Â | The start time of a fragment, relative to the start of the media file |
| Â | Â |
| Â | The end time of a fragment, relative to the start of the media file |
| Â | Â |
| Â | The duration of a fragment |
| Â |
Versioning
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| Provides structural information about the chain versions of the same logical file. Each record in the chain is a separate record itself with its own MediaObjectId / FragmentId. All records in the chain have the same Versioning > Id. |
| |||
|
| Untracked for records without versioning, otherwise possible values are Draft, Head, Rejected, Tail. |
| ||
|
| Has the same value for an entire versioning chain; its value is the MediaObjectId of the first record in the chain (with Version = 1). |
| ||
|
| Positional index in the chain of versions, starting from Version 1. |
|
Ensembles
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| Â | Series of collections the file belongs to |
| Â | |
|
| Sub field of |  | ||
| Â | Series of sets the file belongs to |
| Â | |
|
| Sub field of |  | ||
| Â | Series of newspapers the file belongs to |
| Â | |
|
| Sub field of | Â |
Relations
Key | Sub Key | Description | Remark | Read-only | Searchable |
---|---|---|---|---|---|
|  | Series of files related with this file. Depending on your installation different sub fields of |
| Â | Â |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
|
| Points to a record for which a suggestion is made |
| Â | |
|
| Points to a suggestion which is made for this record |
| Â |
Field Definition
New since 21.3
Key | Sub Key 1 | Sub Key 2 | Description | Remark | Read-only | Search- able |
---|---|---|---|---|---|---|
| Â | Â | Contains a link to a particular field definition described by its dotted key and its long translations |
| Â | |
|
| Â | The dotted key for the field definition, for example |
|
| |
|
| Â | The label of the field definition in various languages |
|
| Â |
|
|
| Dutch label |
|
| Â |
|
|
| English label |
|
| Â |
|
|
| French label |
|
| Â |
Rights Management FieldsÂ
Rights management fields provide information about who can access, edit or export files.
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| Â | The different permissions associated with the file |
| Â | Â |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
|
| Sub field of |
| Â | |
| Â | One of the Zones linked with the record | Â | Â | |
|
| Id of the Zone |
| ||
|
| Name of the Zone | Â | ||
| Â | The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations. |
| Â | |
| Â | Whether or not the file is expired. This field is only for advanced installations. | Â | Â | |
| Â | The phase of the record. |
|
Record Information
This new family since 22.2
provides additional information about helper records such as UserSuggestion
.
Key | Sub Key #1 | Sub Key #2 | Description | Remark | Read-only | Search |
---|---|---|---|---|---|---|
| Â | Â | The different permissions associated with the file |
| Â | Â |
|
| Â | The first name of the requested new user |
| Â | Â |
|
| Â | The last name of the requested new user |
| Â | Â |
|
| Â | The email of the requested new user |
| Â | |
|
| Â | The password hash of the user, because it is a hidden field, they actual value will never be returned or indexed. |
| Â | Â |
| Â | Â | List of preferred labels of a thesaurus suggestion |
| Â | Â |
|
| Â | A single preferred label |
| Â | Â |
|
|
| Language of the preferred label |
| Â | Â |
|
|
| The preferred label itself |
| Â | Â |
| Â | Â | List of alternative labels of a thesaurus suggestion |
| Â | Â |
|
| Â | A single alternative label |
| Â | Â |
|
|
| Language of the alternative label |
| Â | Â |
|
|
| The alternative label itself |
| Â | Â |
Governance
This new family since 24.1
provides information about the lifecycle of objects.
Key | Sub Key | Description | Remark | Read-only | Search |
---|---|---|---|---|---|
| Â | Governs how long objects should be stored before they are destructed. |
| Â | Â |
|
| The number of months or years to store the object |
| Â |
|
|
| Whether it concerns a month or year. For now it uses the Dutch labels |
| Â |
|
| Â | When this timer fires the object is destructed by deleting its representations |
| Â | Â |
|
| When the timer should fire |
| Â |
|
|
| If filled out, the timer has fired at this instant |
| Â |
|