Export Structure
- Alexis Rombaut
In version 25.1 the structure of exports is harmonized such that the behaviour of https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4064772158, flat data objects and https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4486791184 is the same
Parameters
The following parameters control the behaviour of the export
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 |
Several other parameters are available as documented in the MediaHaven REST API.
Structure
The https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4064378938 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 |
|---|---|---|---|
Flat data |
| Original file name | A flat list of 1 or 2 files (depending on the requested sources) |
Data |
| Original file name | A flat list of 1 or 2 files (depending on the requested sources) |
Intellectual object |
| Title |
|
Notes
For intellectual objects, an XML file in the METS format is always included, even when no metadata is requested
See SIPs | 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.1it will be possible to mix multiple records of different https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4064378938 inside a single exportWhen the data object has a metadata field
OriginalPath, that path will be appended to the path inside the ZIPDuring 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 |
|---|---|---|---|---|---|
1 Record |
|
|
|
| N/A |
1 Record |
|
|
|
| N/A |
1 Record |
|
|
|
| N/A |
Multiple records |
|
|
|
|
|
Multiple records |
|
|
|
|
|
Multiple records |
|
|
|
|
|