Warning |
---|
This release is currently under development and content of this page is subject to change without notice. |
...
Descriptive fields are modifiable fields that describe files for purposes such as discovery.
Key | Sub Key | Description | Format | Read-only | Searchable | Sortable | Harvested |
---|---|---|---|---|---|---|---|
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 |
...
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 |
| |||
ImageOrientation | The orientation of the image |
|
...
Structural Fields
Anchor | ||||
---|---|---|---|---|
|
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 |
...
- Removed the column Search in this documentation because from now on the keys used in the key search queries match with the flattened key of the field
- The old search keys are still supported for backwards compatibility compatibility
- New
Technical
fieldPronomId