Skip to content

Specification of an Import File

Key-Facts

  • An import file contains structured information, which are necessary to create a new archiving job. (analogous to the information and settings, that are specified by using the web interface).
  • The information are stored in JSON notation in the import file.
  • Other content (e.g. comments)besides the JSON data structure is not allowed.
  • UTF-8 is expected as charcter encoding.
  • An import file must not be greater than 512 KB
  • To avoid to create a new import file from scratch, existing archive records could be exported as JSON. The export function is located in the data management portal within the overview over all archive records. There the button DMP Export is displayed next to editable archive records, which triggers the export.

JSON Specification

Version mandatory | Number

Specifies the version of the import file specification - Expects the value 1

"version": 1

Title mandatory | string

Specifies the name of the archive record

"title": "2014-10 Pyrosequencing"

Data Project mandatory | Number

Specifies the assignment of the archive record to a data project - Expects the numeric ID of a datenproject - see also: [list of all dataprojects as JSON]

"dataproject": 29"

Archive file mandatory | object

Specifies the file to be archived

"archivefile": { ... }

source mandatory | string

Specifies the source system, where the file to be archived is located (e.g. user directory, group share, EVE computing cluster, ...) - Expects the alphanumeric ID of a source system - see also: [list of all source systems as JSON]

"source": "EVE"

path mandatory | string

Specifies the path, where the file to be archived is located - Must be specified relative to the data source - Must begin without slash and end with a slash - May be an empty string, if the file is locatet in the root of the data source

"path": "username/folder1/"

"path": ""

file name mandatory | string

Specifies the filename of the file to be archived - Must be specified relative to the path within the data source

"filename": "data.zip"

md5_file optional | string

Specifies the filename of a file, which contains a md5 checksum - If specified, the archiving process will only succeed, if the checksum of the archived file is equal to the checksum in the specified file - The file must be located in the same directory like the file to be archived

"md5_file": "data.zip.md5sum"

Visible _for_ufz_external_persons_in_drp mandatory | boolean
  • true: The archive record will be visible for UFZ external users within the data research portal
  • false: The archive record will be invisible for UFZ external users within the data research portal (the metadata are always visible by UFZ members)

"visible_for_ufz_external_persons_in_drp": true

Download permission mandatory | object

Specifies, who is entitled to download the archived file - At least one sub attribute must be specified - Several sub attribute are possible

"downloadpermissions": { ... }

all optional | boolean
  • true: The archived data can be downloaded worldwide
  • If this option is specified, none of the other sub attributes may be used!

"all": true

ufz optional | boolean

true: All UFZ members are entitled to download the archived data

"ufz": true

departments optional | array of number

The members of the specified departments are entitled to download the archived data - Expects numeric IDs of the according departments - see also: [list of all departments as JSON]

"departments": [20401, 90020]

data projects optional | array of number

The members of the specified dataprojects are entitled to download the archived data - Expects numeric IDs of the according datenprojects - see also: [list of all dataprojects as JSON]

"dataprojects": [29, 30]

accounts optional | array of string

The specified UFZ employees are entitled to download the archived data - Expects the usernames of the according UFZ employees

"accounts": ["spet", "abbrent"]

mails optional | array of string

Owners of the specified e-mail addresses are entitled to download the archived data via the data exploration portal (DRP) - Expects the e-mail addresses of the according external persons/li>

"mails": ["external.partner@example.com", "interested.person@example.com"]

nobody optional | boolean
  • true: Nobody is entitled to download the archived data
  • If this option is specified, none of the other sub attributes may be used!

"nobody": true

License mandatory | object

Specifies the file Specifies, which license and terms of use the dissemination of the archived data are subjected to - Exactly one sub attribute must be specified

"license": { ... }

creative common 4.0 optional | object

Specifies Creative Commons in version 4.0 as license and terms of us - All sub attributes must be specified

"creativecommons4.0": { ... }

modiication mandatory | string

Specifies, if it's allowed to modify or process the data - Expects exactly one of the following options: - "no": no - "yes": yes (unrestricted) - "restricted": yes (as long as others share alike)

"modification": "no"

"modification": "yes"

"modification": "restricted"

commercial mandatory | boolean

Specifies, if the commercial use of the data is allowed - true: commercial use is allowed - false: commercial use is not allowed

"commercial": false

preset optional | number

Specifies a preset license and terms of use - Expects the numeric ID of the according preset license - see also: [list of all preset licenses as JSON]

"preset": 1

file optional | string

Specifies the filename of a file, which contains the license and terms of use - The file must be located in the same directory like the file to be archived - The size of the file must be less than 5 MB and it must be a PDF file, which name ends with ".pdf" !!! note "" "file": "License.pdf"

none optional | boolean
  • true: No license and terms of use will be specified
  • This option is only possible, if nobody is entitled to download the archived data! !!! note "" "none": true
I CONFIRM THAT PROVIDING THE DATA TO THE SPECIFIED PEOPLE DOES NOT VIOLATE THE LICENCE AND TERMS OF USE mandatory | string

Is used to confirm, that the archiving of the data and their provision with respect to the selected group of people does not violate the license and terms of use of data. - Expects as value the username of the user, who triggers the archiving job by the import file

"I CONFIRM THAT PROVIDING THE DATA TO THE SPECIFIED PEOPLE DOES NOT VIOLATE THE LICENCE AND TERMS OF USE": "spet"

metadata mandatory | object

Specifies the description of the record through metadata

"metadata": { ... }

dublincore mandatory | object

"dublincore": { ... }

subject mandatory | array of strings

Keywords or group of words which describe the topic or subject of the data. If there are more than one keyword or group of words, please specifiy them separately.

"subject": ["subject1","subject2"]

description mandatory | string

Detailed description of the data. (for example in the form of a summary or a table of contents) Should be written in english language if a DOI is registered for the dataset.

"description": "Description ..."

coverage optional | string

The given specification concerning coverage is freely selectable. Please refer to the examples: - Local area of ​​application (Place name or the the geographical coordinates) - temporal area of ​​application (date, time range, year, century, ...) - Legal domicile - Sphere of influence - ...

"coverage": "Hohes Holz 2013"

pubdate optional | object

The date when the data was or will be made publicly available. In the case of datasets, "publish" is understood to mean making the data available on a specific date to the community of researchers. - The year must be specified / all other attributes are optional - If a day is specified, the month must also be specified

"pubdate":{"year": 2000,"month": 1, "day": 1}

type mandatory | array of strings

Classification of the data - Expects the alphanumeric IDs of data types - see also: [list of all data types as JSON]".pdf"

"type": ["DATASET", "TEXT"]

status optional | array of strings

Is the data raw, processed or derived? (Note: not an attribute of the standard dublin core) - Expects the alphanumeric IDs of data status - see also: [list of all data status as JSON]

"status": ["ABGELEITET"]

format optional | array of strings

Specification of the main data types within the to be described data set. If there are more than one data type, please specify them separately. Examples: "jpeg", "csv", "pdf".

"format": ["csv", "txt", "xls"]

dataquality optional | string

Marks the quality of the data (Note: not an attribute of the standard dublin core) - Expects the alphanumeric ID of a data quality marking - see also: [list of all data quality markings as JSON]

"dataquality": "ASSURED"

creator optional | array of strings

Specification on the author of the data. - Persons and institutions can be specified as author.n - Please specify a person with the following format "last name, first name" (or with "last name, first letter of the first name.", if the first name is not known completely) - If there are more than one author, please specify them separately. - The order should be the same as used in publications. If the person is an employee of the UFZ, they can be specified by username:

"creator": [["username", "abbrent"],["username", "tschnick"],["username", "spet"]]

Otherwise, the specification is possible by using free text:

"creator": [["text", "M. Mueller"],["text", "M. Mustermann"],["text", "UFZ"]]

Mixing of both forms is also possible:

"creator": [["username", "abbrent"],["text", "M. Mustermann"],["username", "tschnick"],["text", "UFZ"]]

source optional | array of strings

Reference to the source / origin of the data set. The declaration have to be defined as a DOI identifier, a catalog reference like ISBN or another Uniform Resource Locator(URL)/Uniform Resource Identifier(URI). If this specification is not possible, other source specifications are valid too. If there are more than one source/origin, please specify them separately. Examples: - DOI: 10.2312/RADIESCHEN_007 - http://ebooks.gfz-potsdam.de/pubman/faces/viewItemFullPage.jsp?itemId=escidoc:117053 - ISBN-13: 978-0470088708 - Image from page 54 of the 1922 edition of Romeo an Juliet

"source": ["DOI: 10.2312\/RADIESCHEN_007","ISBN-13: 978-0470088708"]

relation optional | array of string

Link to data sources which are related to the described data ("please refer to"-source). The declaration have to be defined as a DOI identifier, a catalog reference like ISBN or another Uniform Resource Locator(URL)/Uniform Resource Identifier(URI). If this specification is not possible, other source specifications are valid too. If there are more than one source/origin, please specify them separately. Examples: - DOI: 10.2312/RADIESCHEN_007 - http://ebooks.gfz-potsdam.de/pubman/faces/viewItemFullPage.jsp?itemId=escidoc:117053 - ISBN-13: 978-0470088708 - Image from page 54 of the 1922 edition of Romeo an Juliet

"relation": ["http:\/\/ebooks.gfz-potsdam.de\/?itemId=escidoc:117053","DOI: 10.2312\/RADIESCHEN_007"]

publisher mandatory | array of objects

Specification of the institution and/or person which/who are the original publisher. Publishing institutions/persons which/who are indentical with the author should not be specified again. If there are more than one publisher, please specify them separately. If the person is an employee of the UFZ, they can be specified by username:

"publisher": [["username", "abbrent"],["username", "tschnick"],["username", "spet"]]

Otherwise, the specification is possible by using free text:

"publisher": [["text", "M. Mueller"],["text", "M. Mustermann"],["text", "UFZ"]]

Mixing of both forms is also possible:

"publisher": [["username", "abbrent"],["text", "M. Mustermann"],["username", "tschnick"],["text", "UFZ"]]

right sholder mandatory | array of objects

Specification of the institution or person which/who has the ownership of the data. If necessary please select "nobody". If the person is an employee of the UFZ, they can be specified by username:

"rightsholder": [["username", "abbrent"],["username", "tschnick"],["username", "spet"]]

Otherwise, the specification is possible by using free text:

"rightsholder": [["text", "M. Mueller"],["text", "M. Mustermann"],["text", "UFZ"]]

Mixing of both forms is also possible:

"rightsholder": [["username", "abbrent"],["text", "M. Mustermann"],["username", "tschnick"],["text", "UFZ"]]

contributor optional | array of objects

Further institutions and/or persons which/who have contributed to the creation of the data. Contributing institutions/persons which/who are indentical with the author should not be specified again. If the person is an employee of the UFZ, they can be specified by username:

"contributor": [["username", "abbrent"],["username", "tschnick"],["username", "spet"]]

Otherwise, the specification is possible by using free text:

"contributor": [["text", "M. Mueller"],["text", "M. Mustermann"],["text", "UFZ"]]

Mixing of both forms is also possible:

"contributor": [["username", "abbrent"],["text", "M. Mustermann"],["username", "tschnick"],["text", "UFZ"]]

citation optional | string

How to cite the data? (Note: not an attribute of the standard dublin core)

"citation": "this data are managed by ... , contact: ..."

contact optional | array of strings

Listing of contact data. Hint: These data are potentially visible from outside of the UFZ! Any detail is possible (name, address, telephone/fax, function, ...) If there are more than one contact, please specifiy them separately (plus button).

"contact": ["contact1","contact2"]

data mandatory | object

Date or period of creation for the data set

"date": { ... }

from mandatory | object

Single point in time (if the sub attribute "to" is not specified) or begin of a time range - The year must be specified / all other attributes are optional - If a minute is specified, the hour must also be specified - If a hour is specified, the day must also be specified - If a day is specified, the month must also be specified

"from": {"year": 2000,"month": 1,"day": 1,"hour": 0,"minute": 0}

to optional | object

End of a time range - If "to" is specified, the year must be specified / all other attributes are optional - If a minute is specified, the hour must also be specified - If a hour is specified, the day must also be specified - If a day is specified, the month must also be specified

"from": {"year": 2000,"month": 12,"day": 31,"hour": 23,"minute": 59}

language mandatory | array of strings

Specification of used language within the dataset. If there are more than one language to specify, please specify them separately. - Expects language codes as ISO 639-1

"language": ["de", "en"]

version optional | string

The version number of the resource. Valid formats: - majorVersion - majorVersion.minorVersion - majorVersion.minorVersion.correctionVersion

"version": "1.0"

audience optional | array of strings

Who is the target group of the data?

"audience": ["Scientists working on the topic ...","..."]

provenance optional | array of strings

Hints for changes in the ownership or custody of the data since its creation.

"provenance": ["Transfer of the data from KIT to the UFZ in 2010","..."]

instructional methode optional | string

Teaching method to convey the knowledge of the given data set.

"instructionalmethod": "by experiments"

accrualmethod optional | string

The procedure, how new data is added to the collection.

"accrualmethod": "Acquisition of new data via http:\/\/www.dwd.de"

accrual periodicity optional | string

Specification how often the update of the data does occur. Example: "no update", "irregular","yearly"

"accrualperiodicity": "no updates"

accrual policy optional | string

Strategy to update the data - Expects the alphanumeric ID of an update policy - see also: [list of all update policies as JSON]

"accrualpolicy": "CLOSED"

geocore optional | object

"geocore": { ... }

coordinates optional | array of arrays

Where were the data collected or which geographical area they are related to? - Expects an Array with coordinates - A coordinate must also be specified as an array with the format [Lat, Lng] - Lat and Lng must be specified as float according to the reference system WGS84 - A single point is determined, if only one coordinate is specified - Otherwise, at least 3 coordinates are required to specify a polygon - Rectangles must also be specified as a polygon Point:

"coordinates": [[52.075732551279, 11.214706425089]]

Polygon:

"coordinates": [[52.075732551279, 11.214706425089],[52.091977581076, 11.214706425089],[52.091977581076, 11.237365726847],[52.075732551279, 11.237365726847]]

reference_system optional | string

Spatial reference system, on which data are based. - Expects the alphanumeric ID of an reference system - see also: [list of all reference systems as JSON]

"reference_system": "WGS84__UTM_Zone_32N"

category optional | string

Thematic classification of the data. - Expects the alphanumeric ID of an thematic classification - see also: [list of all thematic classifications as JSON]

"category": "hyperspectraldata"

type optional | string

Type of data of the archived geo data - Expects the alphanumeric ID of an type of data - see also: [list of all types of data as JSON]

"type": "grid"

data type optional | string
  • Expects the alphanumeric ID of an datatype
  • see also: [list of all datatypes as JSON]

"datatype": "float"

resolution optional | object

Resolution of the archived geo data

"resolution": { ... }

resolution_in_m optional | number

Resolution in m

"resolution_in_m": 2.3

resolution_in_degree optional | number

Resolution in degree

"resolution_in_deg": 4.5

rows optional | number

Number of rows

"rows": 150000

col optional | number

Number of columns

"type": "grid"

spectral range optional | object

Spectral data area of the archived geo data

"spectral_range": { ... }

min_in_nm optional | number

Minimum wavelength in nano meter

"min_in_nm": 400

max_in_nm optional | number

Maximum wavelength in nano meter

"max_in_nm": 900

binning_vnir optional | number

Binning VNIR

"binning_vnir": 4

binning_swir optional | number

Binning SWIR

"binning_swir": 2

climate core optional | object

"climatecore": { ... }

cloud_cover optional | number

Cloud cover in percent (valid are integer between 0 and 100)

"cloud_cover": 25

error message optional | string

If an error occurred while processing the import job, the error message will be written back into this attribute

"errormessage": "Errormessage ..."

attribute_specific_errors optional | object

If the import file is concerning the content invalid, the attribute specific error messages will be written back into this attribute.

"attribute_specific_errors": {"archivefile.source": "invalid id","metadata.dublincore.subject": "mut not be empty",...}

created_archive_record optional | object

If the import request results in an archive record that has been successfully or unsuccessfully archived, then information about the created archive data record is written back to this attribute.

"created_archive_record": {"id": 1234}