Export Structure

In version 25.1 the structure of exports is harmonized such that the behaviour of Data Objects, flat data objects and Intellectual Objects is the same

Parameters

The following parameters control the behaviour of the export

	Parameter	Description	Values

	Parameter	Description	Values
1	RecordIds	Specifies the records to export	Valid record IDs
2	Export Source	Whether to include the original, the access representation/browse or both.	Original, Access or OriginalAndAccess
3	Options	Several options to control the metadata and transformations for the export files	Export Locations \| Export metadata options Export Locations \| Export image options Export Locations \| Export audio options Export Locations \| Export document options

Several other parameters are available as documented in the MediaHaven REST API.

Structure

The Record Structure of the requested records and their number determines the shape of the generated export and the naming of the files.

Record Structure	Export is a ZIP?	File Name	Output

Record Structure	Export is a ZIP?	File Name	Output
Flat data	When requesting multiple records When specifying two sources or 1 source plus metadata	Original file name `Descriptive.OriginalFilename`	A flat list of 1 or 2 files (depending on the requested sources)
Data	When requesting multiple records When specifying two sources or 1 source plus metadata	Original file name `Descriptive.OriginalFilename`	A flat list of 1 or 2 files (depending on the requested sources)
Intellectual object	Always	Title `Descriptive.Title`	1 Record 1 XML file in the METS format describing the structure of that intellectual object A flat list with 1 or 2 files per child (flat) data object depending on the requested sources Multiple records A folder per intellectual object containing 1 XML file in the METS format describing the structure of that intellectual object A flat list with 1 or 2 files per (grand)child (flat) data object depending on the requested sources

Notes

For intellectual objects, an XML file in the METS format is always included, even when no metadata is requested
- See Complex Objects 2.0 aka SIP | METSfor information regarding this XML
- Since intellectual objects can contain 0 actual files (e.g. empty or only intellectual children) the presence of the METS XML ensures there is at least one file for the intellectual object inside the export
- When metadata is requested the METS XML will additionally contain the metadata of the object and its children in the requested metadata format.
From version 25.1 it will be possible to mix multiple records of different Record Structure inside a single export
When the data object has a metadata field OriginalPath, that path will be appended to the path inside the ZIP
- During ingest https://mediahaven.atlassian.net/wiki/x/LgBgCAEthe original paths inside the SIP are stored in the field OriginalPath, such that when exporting the intellectual object later on the structure of the original SIP can be reconstructed.
- In the examples below “Collection 2” has a child data object “Child22.docx” with OriginalPath=Docs

Examples

The examples below show the file and folder structure inside the export ZIP.

Export Type	Combination	Data Object	Flat Data Object	Intellectual Object	Mixing (specifiy multiple records with different structrures, e.g a flat data object, a data object and intellectual object)

Export Type	Combination	Data Object	Flat Data Object	Intellectual Object	Mixing (specifiy multiple records with different structrures, e.g a flat data object, a data object and intellectual object)
1 Record	Sources: Original No metadata	Child11.tiff Note: export is not a ZIP because there is only 1 file	Flat.webp Note: export is not a ZIP because there is only 1 file	Collection 1.xml (METS) Child11.tiff (original) Child12.mxf (original)	N/A
1 Record	Sources: Original + Access No metadata	Child11.tiff (original) Child11.jpg (access)	Flat.webp (original) Flat.jpg (access)	Collection 1.xml (METS) Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access)	N/A
1 Record	Sources: Original + Access With metadata	Child11.xml (metadata) Child11.tiff (original) Child11.jpg (access)	Flat.xml (metadata) Flat.webp (original) Flat.jpg (access)	Collection 1.xml (METS+metadata) Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access)	N/A
Multiple records	Sources: Original No metadata	Child11.tiff (original) Child12.mxf (original)	Flat1.webp (original) Flat2.tiff (original)	Collection 1 (folder) Collection 1.xml (METS) Child11.tiff (original) Child12.mxf (original) Collection 2 (folder) Collection 2.xml (METS) Child21.tiff (original) Docs (subfolder due OriginalPath) Child22.docx(original)	Child11.tiff (original) Child12.mxf (original) Flat1.webp (original) Flat2.tiff (original) Collection 1 (folder) Collection 1.xml (METS) Child11.tiff (original) Child12.mxf (original)
Multiple records	Sources: Original + Access No metadata	Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access)	Flat1.webp (original) Flat1.jpg (access) Flat2.tiff (original) Flat2.jpg (access)	Collection 1 (folder) Collection 1.xml (METS) Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access) Collection 2 (folder) Collection 2.xml (METS) Child21.tiff (original) Child21.jpg (access) Docs (subfolder due OriginalPath) Child22.docx(original) Child22.pdf (access)	Child11.tiff (original) Child11.jpg (access) Flat1.webp (original) Flat1.jpg (access) Collection 1 (folder) Collection 1.xml Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access)
Multiple records	Sources: Original + Access With metadata	Child11.xml (metadata) Child11.tiff (original) Child11.jpg (access) Child12.xml (metadata) Child12.mxf (original) Child12.mp4 (access)	Flat1.xml (metadata) Flat1.webp (original) Flat1.jpg (access) Flat2.xml (metadata) Flat2.tiff (original) Flat2.jpg (access)	Collection 1 (folder) Collection 1.xml (METS+metadata) Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access) Collection 2 (folder) Collection 2.xml (METS+metadata) Child21.tiff (original) Child21.jpg (access) Docs (subfolder due OriginalPath) Child22.docx(original) Child22.pdf (access)	Child11.xml (metadata) Child11.tiff (original) Child11.jpg (access) Flat1.xml (metadata) Flat1.webp (original) Flat1.jpg (access) Collection 1 (folder) Collection 1.xml (METS+metadata) Child11.tiff (original) Child11.jpg (access) Child12.mxf (original) Child12.mp4 (access)