Skip to content
Snippets Groups Projects
base_scicat_dataset.tsv 3.75 KiB
Newer Older
Anjali Aggarwal's avatar
Anjali Aggarwal committed
slot	class	abstract	alias	description	domain_of	from_schema	multivalued	owner	range	required
>slot	class	abstract	alias	description	domain_of	from_schema	multivalued	owner	range	required
>					"internal_separator: ""|"""					
owner				Owner or custodian of the dataset, usually first name + last name. The string may contain a list of persons, which should then be seperated by semicolons.		https://example.org/MySchema				true
ownerEmail				Email of the owner or custodian of the dataset. The string may contain a list of emails, which should then be seperated by semicolons.		https://example.org/MySchema				
orcidOfOwner				ORCID of the owner or custodian. The string may contain a list of ORCIDs, which should then be separated by semicolons.		https://example.org/MySchema				
contactEmail				Email of the contact person for this dataset. The string may contain a list of emails, which should then be seperated by semicolons.		https://example.org/MySchema				
sourceFolder				Absolute file path on file server containing the files of this dataset, e.g. /some/path/to/sourcefolder. In case of a single file dataset, e.g. HDF5 data, it contains the path up to, but excluding the filename. Trailing slashes are removed.		https://example.org/MySchema				
size				Total size of all source files contained in source folder on disk when unpacked.		https://example.org/MySchema			float	
dataQualityMetrics				Data Quality Metrics is a number given by the user to rate the dataset.		https://example.org/MySchema			float	
creationTime				Time when dataset became fully available on disk, i.e. all containing files have been written. Format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.		https://example.org/MySchema				
type				Characterize type of dataset, either 'raw' or 'derived'. Autofilled when choosing the proper inherited models.		https://example.org/MySchema			type_options	true
keywords						https://example.org/MySchema	true			
description				Free text explanation of contents of dataset.		https://example.org/MySchema				
datasetName				A name for the dataset, given by the creator to carry some semantic meaning. Useful for display purposes e.g. instead of displaying the pid. Will be autofilled if missing using info from sourceFolder.		https://example.org/MySchema				
license				Name of the license under which the data can be used.		https://example.org/MySchema				
techniques						https://example.org/MySchema	true		TechniqueClass	
scientificMetadata		true		JSON object containing the scientific metadata.		https://example.org/MySchema				
principalInvestigator				First name and last name of principal investigator(s). If multiple PIs are present, use a semicolon separated list. This field is required if the dataset is a Raw dataset.		https://example.org/MySchema				true
endTime				End time of data acquisition for this dataset, format according to chapter 5.6 internet date/time format in RFC 3339. Local times without timezone/offset info are automatically transformed to UTC using the timezone of the API server.		https://example.org/MySchema				
creationLocation				Unique location identifier where data was taken, usually in the form /Site-name/facility-name/instrumentOrBeamline-name. This field is required if the dataset is a Raw dataset.		https://example.org/MySchema				
dataFormat				Defines the format of the data files in this dataset, e.g Nexus Version x.y.		https://example.org/MySchema				
proposalId				The ID of the proposal to which the dataset belongs.		https://example.org/MySchema				
instrumentId				ID of the instrument where the data was created.		https://example.org/MySchema				
	ScicatDataset	true				https://example.org/MySchema