Metadata 19.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 used the flattened key, for example +Title:"Breaking News!" +KeywordsKeyword:Politics  
• Searchable / Sortable: In the MediaHaven REST API you can search for it using this value if it is searchable and optionally sort the results (sortable).

Descriptive Fields

Descriptive fields are modifiable fields that describe files for purposes such as discovery.

Key	Sub Key	Description	Format	Read-only	Searchable	Sortable
Title		The title of the file
Description		Description about the file
CreationDate		The date and time the file was originally created	yyyy:MM:dd HH:mm:ss
RightsOwner		The name of the (copyright) owner of the file
Rights		A description about how the file can or can not be disseminated.
Keywords		Series of keywords about the file	ListField
Keywords	Keyword	Sub field of Keywords containing an individual keyword
Categories		Series of categories about the file	ListField
Categories	Category	Sub field of Categories containing an individual category
Publisher		Publisher of the file
Authors		A list of various authors of the file	MulitItemField
AuthorsAuthor		Sub field of Authors containing an individual author
Address		Address of corresponding with the Location	MulitItemField
Address	Formatted	Sub field of Address describing the full address in a single line, e.g. Trump Tower, 725 5th Ave, New York, NY 10022, Verenigde Staten
Location		GPS coordinates corresponding with the Address
Publications		List of locations where the file is published	ListField
Publications	Comment	Sub field of Publications describing a comme
OriginalFilename		The name of the file as it was ingested into MediaHaven
UploadedBy		The name of the user that uploaded the file
KeyframeStart		By default the the field PathToKeyframe refers to the closest keyframe before to time provided by the field FragmentStart. When KeyframeStart is defined it overrides this time.	frames (using a fictitious 25 fps)

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	Searchable	Sortable
OrganisationName	The name of the organisation to which the file belongs
LastModifiedDate	The date and time when the file was last edited	ISO-8601
ExternalId	The ID of the file in an external platform. This field is only for advanced installations.
ArchiveDate	The date and time the file was ingested	yyyy:MM:dd HH:mm:ss
Type	The type of the file (e.g. image, document, page, image, layer, newspaperpage, article, video, videofragment, audio, audiofragment, set, collection, newspaper, metadataonly)
DepartmentName	The name of the department that published the file
Workflow	Describes through which workflow a file was ingested (if applicable)
IngestTape	Describes on which ingest tape the file was provided (if applicable)
IsSynchronized	Indicates whether or not this file or fragment has been synchronized from another MediaHaven.	0 or 1
ExternalUrl	When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven.	URL

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	Searchable	Sortable
OriginalExtension	The extension of the file as it was ingested into MediaHaven
FileSize	The size of the file in bytes				yes, but lexicographically
Md5	The MD5 checksum of the file
MimeType	The mime type of the file, e.g. image/jpg
PronomId	The Pronom ID is a file identification mechanism developed by the National Archives
Width	The width of the file	pixels			yes, but lexicographically
Height	The height of the file	pixels			yes, but lexicographically
ImageSize	Width times height, e.g 1920x1080	pixels times pixels
ImageQuality	The quality of the image	high (image: 1920x1200, video: 1280x720) medium (image: 1024x768, video: 720x540) low
ImageOrientation	The orientation of the image	panorama (aspect >= 2) landscape (2 > aspect >= 1.1) square (1.1 >= aspect > 0.9) portrait (0.9 >= aspect > 0.5) strip (aspect < 0.5)

Time codes

Key	Description	Format	Read-only	Searchable	Sortable
DurationTimeCode	The duration of the media file	HH:mm:ss.SSS
StartTimeCode	The start time of the media file	HH:mm:ss.SSS
EndTimeCode	The end time of the media file	HH:mm:ss.SSS
DurationFrames	The duration of the media file, expressed in frames against a fictitious 25 frames per second	frames (using a fictitious 25 fps)
StartFrames	The start time of the media file, expressed in frames against a fictitious 25 frames per second	frames (using a fictitious 25 fps)
EndFrames	The end time of the media file, expressed in frames against a fictitious 25 frames per second	frames (using a fictitious 25 fps)

Video 

Key	Description	Format	Read-only	Searchable	Sortable
VideoCodec	Description about the video encoding of the file
VideoFps	Frames per second of the video in the file	frames per second (fps)
VideoBitRate	Average bit rate of the video in the file	bits per second (bps)
AudioCodec	Description about the audio encoding of the file
AudioChannels	Total number of audio channels in the flle
AudioSampleRate	Sample rate of the audio tracks in the file	Hz
AudioBitRate	Total average bit rate of all audio tracks	bits per second (bps)
BitRate	Total average bit rate of the container (includes video and audio)	bits per second (bps)

MXF Video

Key	Description	Format	Read-only	Searchable	Sortable
Origin	Number of edit units to skip at the start of the source video codec before the logical of start of the essence	frames
EssenceOffset	File offset to the first partition containing essence	bytes
EditUnitByteSize	> 0: Constant Bit Rate (CBR) MXF: Each edit unit has this fixed size 0: Variable Bit Rate (VBR) MXF: Edit units have a variable size -1: Unrecognized edit unit structure	bytes
RunIn	File offset to the first KLV in the file, typically 0	bytes
FramesPerEditUnit	Number of frames per edit unit	frames
EditRate	Number of edit units per second, if FramesPerEditUnit is 1 this equals the VideoFps	fraction
IndexEditRate	Advanced MXF feature, stored for future usage	fraction

Internal Fields

Internal fields are read-only metadata fields proper to MediaHaven and often not a human readable format opposed to the administrative fields.

Key	Description	Remark	Read-only	Searchable	Sortable
MediaObjectId	The unique identifier of the file	64 characters
FragmentId	The unique identifier of the fragment of the file	96 characters
OriginalStatus	Status of the validation and ingest of the file	in_progress: file is being processed completed: file is successfully stored on storage failed: ingest failed and the file is not succesfully stored on storage
BrowseStatus	Status of the creation of the preview of the file	in_progress: browse is being generated completed: browse is successfully created no_browse: no browse is created for this file type cancelled: ingest failed before a browse was created failed: browse could not be created
ArchiveStatus	The possible values are documented here: Ingest Monitoring
OrganisationId	The ID of the organisation to which the file belongs to. The administrative field OrganisationName provides the human readable name.
IngestSpaceId	The ID of the ingest space the file belongs or belonged to	UUID
IsInIngestSpace	Whether the file still belongs to an ingest space	0 or 1
UploadedById	The user ID of the user that uploaded the file, the administrative field UploadedBy provides the human readable name.	UUID
DepartmentId	uuid of the department the file was published with, the administrative field DepartmentName provides the human readable name.	UUID
IsFragment	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
HasKeyframes	Indicates whether or not the the file has a series of keyframes (applicable to documents, multi-page images, video and audio)	0 or 1
ContainsGeoData	Indicates whether or not the file has geolocation data associated to it	0 or 1

Browses 

Key	Sub Key #1	Sub Key #2	Description	Remark	Read-only
Browses			List of browse formats generated for the file	ComplexField
Browses	Browse		Description of a single browse format of the file	MapField
Browses	Browse	Label	Unique label of this browse format
Browses	Browse	Container	Extension of the container of this browse, e.g. jpg, mp4
Browses	Browse	BaseUrl	URL to the path containing the files associated with this browse format
Browses	Browse	PathToKeyframe	Relative path to the main still image of the file. Prefix with BaseUrl to obtain the complete URL.
Browses	Browse	PathToKeyframeThumb	Relative path to the main still image of the file (thumb version). Prefix with BaseUrl to obtain the complete URL.
Browses	Browse	PathToVideo	Relative path to the video preview of the file. Prefix with BaseUrl to obtain the complete URL.
Browses	Browse	FileSize	File size of the PathToVideo for audio / video or PathToKeyframe for other content.	bytes
Browses	Browse	Width	Width of the preview (PathToKeyframe)	pixels
Browses	Browse	Height	Height of the preview (PathToKeyframe)	pixels
Browses	Browse	...	All keys available under the item #Video on this same page

Distributions 

Key	Sub Key	Description	Remark	Read-only	Searchable
Distributions		List of distribution channels where the file has been distributed to	ListField
Distributions	Distribution	Provides information about a single channel in the form of <protocol>:<ID>, e.g. jwplayer:bZZVWxol	protocol:id

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.

Fragments

Key	Sub Key	Description	Remark	Read-only	Searchable	Sortable
Fragments		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.	ListField
Fragments	Fragment	Sub field of Fragments giving the FragmentId of each fragment this file contains	FragmentId
MainFragment		For a pure fragment, this refers the FragmentId of main fragment. For the main fragment this field is empty.	SimpleField
FragmentStartFrames		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 (using a fictitious 25 fps)
FragmentEndFrames		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 (using a fictitious 25 fps)
FragmentDurationFrames		The duration of a fragment, expressed in frames against a fictitious 25 frames per second	frames (using a fictitious 25 fps)
FragmentStartTimeCode		The start time of a fragment, relative to the start of the media file	HH:mm:ss.SSS
FragmentEndTimeCode		The end time of a fragment, relative to the start of the media file	HH:mm:ss.SSS
FragmentDurationTimeCode		The duration of a fragment	HH:mm:ss.SSS

Ensembles

Key	Sub Key	Description	Remark	Read-only	Searchable	Sortable
Collections		Series of collections the file belongs to	ListField
Collections	Collection	Sub field of Collections providing the ID of an individual the collection the file belongs to
Sets		Series of sets the file belongs to	ListField
Sets	Set	Sub field of Sets providing the ID of an individual set the file belongs to
Newspapers		Series of newspapers the file belongs to	ListField
Newspapers	Newspaper	Sub field of Newspapers providing the ID of an individual newspaper the file belongs to

Relations

Key	Sub Key	Description	Remark	Read-only	Searchable	Sortable
Relations		Series of files related with this file. Depending on your installation different sub fields of Relations might be defined.	MultiItemField
Relations	PreviousVersion	Sub field of Relations providing the FragmentId of an individual file which is the previous version of this file	FragmentId
Relations	NextVersion	Sub field of Relations providing the FragmentId of an individual file which is the next version of this file	FragmentId
Relations	Contains	Sub field of Relations providing the FragmentId of an individual file which this file contains	FragmentId
Relations	ContainedBy	Sub field of Relations providing the FragmentId of an individual file that contains this file	FragmentId
Relations	Associated	Sub field of Relations providing the FragmentId of an individual file which is associated with this file	FragmentId

Rights Management Fields 

Rights management fields provide information about who can access, edit or export files.

Key	Sub Key	Description	Remark	Read-only	Searchable	Sortable
Permissions		The different permissions associated with the file	MultiItemField
Permissions	Read	Sub field of Permissions providing ID of a user group with read rights	UUID
Permissions	Write	Sub field of Permissions providing ID of a user group with write rights	UUID
Permissions	Export	Sub field of Permissions providing ID of the user groups with export rights	UUID
ExpiryDate		The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations.	yyyy:MM:dd HH:mm:ss
ExpiryStatus		Whether or not the file is expired. This field is only for advanced installations.

Changelog

Changes versus Metadata 18.4:

1. Removed the column Search in this documentation because from now on the keys used in the search queries match with the flattened key of the field
2. The old search keys are still supported for backwards compatibility
3. New Technical field PronomId
4. New Descriptive field KeyframeStart