Page Comparison

...

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 Search / 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).Read-only: This field cannot be modified in the user interface or API calls

Descriptive Fields

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

SearchMediaObjectFragmentrightsowner

Key	Sub Key	Description	Format		Read-only	Searchable	Sortable	Harvested
Title		The title of the fileMediaObjectFragmentTitle
Description		Description about the fileMediaObjectFragmentScriptDescription
CreationDate		The date and time the file was originally created	yyyy:MM:dd HH:mm:ss	MediaObjectFragmentCreationDate
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	ListFieldsearch using the sub field
Keywords	Keyword	Sub field of Keywords containing an individual keywordMediaObjectFragmentKeywordsKeyword
Categories		Series of categories about the file	ListField	search using the sub field
Categories	Category	Sub field of Categories containing an individual category	MediaObjectFragmentCategoriesCategory
Publisher		Publisher of the file
Authors		A list of various authors of the file	MulitItemFieldsearch using the sub fields
AuthorsAuthor		Sub field of Authors containing an individual authorMediaObjectFragmentAuthorsAuthor
Address		Address of corresponding with the Location	MulitItemField	search using the sub field
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	MediaObjectFragmentaddress
Location		GPS coordinates corresponding with the AddressMediaObjectFragmentlocation
Publications		List of locations where the file is published	ListFieldsearch using the sub field
Publications	Comment	Sub field of Publications describing a comme	MediaObjectFragmentPublicationsComment
OriginalFilename		The name of the file as it was ingested into MediaHavenMediaObjectOriginalFilename
UploadedBy		The name of the user that uploaded the file	MediaObjectUploadedBy

Administrative Fields

Anchor
Administrative Administrative

Administrative Fields are human readable read-only fields which are used for managing and preserving files in MediaHaven.

SearchMediaObjectOwnerName

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

Technical Fields

Anchor
Technical Technical

...

Common

SearchTechnical/WidthTechnical/Height

Key	Description	Format		Sidecar (xpath)	Read-only	Searchable	Sortable
OriginalExtension	The extension of the file as it was ingested into MediaHaven	MediaObjectOriginalExtension	Technical/OriginalExtension
FileSize	The size of the file in bytesMediaObjectFileSize	Technical/FileSize				yes, but lexicographically
Md5	The MD5 checksum of the file	MediaObjectMd5	Technical/Md5the file
MimeType	The mime type of the file, e.g. image/jpgMediaObjectMimeType	Technical/MimeType
Width	The width of the file	pixels	ImageWidth				yes, but lexicographically
Height	The height of the file	pixels	ImageHeight				yes, but lexicographically
ImageSize	Width times height, e.g 1920x1080	pixels times pixels	ImageSize	Technical/ImageSize
ImageQuality	The quality of the image	high (image: 1920x1200, video: 1280x720) medium (image: 1024x768, video: 720x540) low	ImageQuality	Technical/ImageQuality
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) ImageOrientation	Technical/ImageOrientation

Time codes

Search

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

Video 

Anchor
Video Video

Search

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

MXF Video

Key	Description	Format	Search	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	framesOrigin
EssenceOffset	File offset to the first partition containing essence	bytesEssenceOffset
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	bytesEditUnitByteSize
RunIn	File offset to the first KLV in the file, typically 0	bytesRunIn
FramesPerEditUnit	Number of frames per edit unit	frames	FramesPerEditUnit
EditRate	Number of edit units per second, if FramesPerEditUnit is 1 this equals the VideoFps	fractionEditRate
IndexEditRate	Advanced MXF feature, stored for future usage	fraction	IndexEditRate

Internal Fields

Anchor
Internal Internal

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

SearchMediaObjectIdMediaObjectOwner

Key	Description	Remark		Read-only	Searchable	Sortable
Anchor MediaObjectId MediaObjectId MediaObjectId	The unique identifier of the file	64 characters
Anchor FragmentId FragmentId FragmentId	The unique identifier of the fragment of the file	96 charactersMediaObjectFragmentId
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 MediaObjectOriginalStatus
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 MediaObjectBrowseStatus
ArchiveStatus	The possible values are documented here: Ingest Monitoring	MediaObjectArchiveStatus
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	MediaObjectFragmentingestspacename
IsInIngestSpace	Whether the file still belongs to an ingest space	0 or 1MediaObjectFragmentisiningestspace
UploadedById	The user ID of the user that uploaded the file, the administrative field UploadedBy provides the human readable name.	UUIDMediaObjectUploadedById
DepartmentId	uuid of the department the file was published with, the administrative field DepartmentName provides the human readable name.	UUIDMediaObjectDepartmentId
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 1MediaObjectFragmentisfragment
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	MediaObjectHasKeyframes
ContainsGeoData	Indicates whether or not the file has geolocation data associated to it	0 or 1MediaObjectFragmentContainsGeoData

Browses 

Anchor
Browses Browses

Key	Sub Key #1	Sub Key #2	Description	Remark	Search	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 

Anchor
Distributions Distributions

Search

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:idDistributionsDistribution

Structural Fields 

Anchor
Structural Structural

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

Search

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	search using the sub field
Fragments	Fragment	Sub field of Fragments giving the FragmentId of each fragment this file contains	FragmentIdFragmentsFragment
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)	MediaObjectFragmentStart
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)MediaObjectFragmentEnd
FragmentDurationFrames		The duration of a fragment, expressed in frames against a fictitious 25 frames per second	frames (using a fictitious 25 fps)MediaObjectFragmentDuration
FragmentStartTimeCode		The start time of a fragment, relative to the start of the media file	HH:mm:ss.SSS MediaObjectFragmentStartTimeCode
FragmentEndTimeCode		The end time of a fragment, relative to the start of the media file	HH:mm:ss.SSS MediaObjectFragmentEndTimeCode
FragmentDurationTimeCode		The duration of a fragment	HH:mm:ss.SSS	MediaObjectFragmentDurationTimeCode

Ensembles

Search

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

Relations

Search

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	search using the sub fields
Relations	PreviousVersion	Sub field of Relations providing the FragmentId of an individual file which is the previous version of this file	FragmentIdRelationsPreviousVersion
Relations	NextVersion	Sub field of Relations providing the FragmentId of an individual file which is the next version of this file	FragmentIdRelationsNextVersion
Relations	Contains	Sub field of Relations providing the FragmentId of an individual file which this file contains	FragmentIdRelationsContains
Relations	ContainedBy	Sub field of Relations providing the FragmentId of an individual file that contains this file	FragmentIdRelationsContainedBy
Relations	Associated	Sub field of Relations providing the FragmentId of an individual file which is associated with this file	FragmentIdRelationsAssociated

Rights Management Fields 

Anchor
RightsManagement RightsManagement

...

Key	Sub Key	Description	Remark	Search	Read-only	Searchable	Sortable
Permissions		The different permissions associated with the file	MultiItemFieldsearch using the sub fields
Permissions	Read	Sub field of Permissions providing ID of a user group with read rights	UUIDPermissionsRead
Permissions	Write	Sub field of Permissions providing ID of a user group with write rights	UUIDPermissionsWrite
Permissions	Export	Sub field of Permissions providing ID of the user groups with export rights	UUIDPermissionsExport
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	MediaObjectExpiryDate
ExpiryStatus		Whether or not the file is expired. This field is only for advanced installations.MediaObjectFragmentExpiryStatus

Changelog

Changes versus Metadata 18.4:

...

1. Removed the column Search in this documentation because from the keys used the key match with the flattened key of the field
2. The old search keys are still supported for backwards compatibility