Metadata 20.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 thie field

Descriptive Fields

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

Key	Sub Key	Description	Format	Read-only	Searchable

Key	Sub Key	Description	Format
`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	DigiHaven / MediaHaven 2.0	Description	Format	Read-only	Searchable

Key	DigiHaven / MediaHaven 2.0	Description	Format
`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
`IsOriginal`		Indicates if the file is an original file	0 or 1
`IsPreservation`	Yes	Indicates if the file is valid for preservation means	0 or 1
`IsAccess`	Yes	Indicates if the file is valid for access means	0 or 1
`RecordType`	Yes	The type of the record.
`RecordStatus`	Yes	The status of the record (e.g. but not limited to New or Published)
`OrganisationExternalId`		External id of the organisation to which the file belongs.
`OrganisationLongName`		The full name of an organisation including white space and punctuation
`PublicationDate`	Yes	The date and time the file was published	`yyyy:MM:dd HH:mm:ss`

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

Key	Description	Format
`OriginalExtension`	The extension of the file as it was ingested into MediaHaven
`FileSize`	The size of the file in bytes
`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
`Height`	The height of the file	pixels
`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

Key	Description	Format
`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, e.g. 0000000025	frames (using a fictitious 25 fps)
`StartFrames`	The start time of the media file, expressed in frames against a fictitious 25 frames per second, e.g. 0000000025	frames (using a fictitious 25 fps)
`EndFrames`	The end time of the media file, expressed in frames against a fictitious 25 frames per second, e.g. 0000000025	frames (using a fictitious 25 fps)

Video

Key	Description	Format	Read-only	Searchable

Key	Description	Format
`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