Document Structure in Detail

The full JSON schema can be found and downloaded here.

Bolded properties are required.

User

mosydb/schema/user.json
For documenting a user’s information
type	object
properties
@id	user@id
	id of the user
	type	string
group	group@id
	related group ID
	type	string
name	Person Name
email	email
	a proper email for contacting the user
	type	string
status	status
	the status of the user - whether is active or not
	type	string
	enum	active, non-active, pending
related_experiments	experiment@ids
	list of experiment @id’s that relate to this user
	type	array
	uniqueItems	True

Group

mosydb/schema/group.json
For describing an affiliated group
type	object
properties
@id	group@id
	id of the user
	type	string
status	status
	status of the user, e.g. active or non-active
	type	string
	enum	active, non-active, pending
PIname	Person Name
email	email
	a proper email for contacting the PI
	type	string
location	location
	type	object
	properties
	institute	institute
		place of research
		type	string
	city	city
		place of research
		type	string
	state	state
		place of research
		type	string
	country	country
		place of research
		type	string
related_users	user@ids
	list of users @id’s who work with this PI
	type	array
	uniqueItems	True

Event

mosydbschema/schema/event.json
Describes an action or observation event
type	object
properties
@id	event@id
	unique ID for an event
	type	string
executed	executed
	distinction on whether the protocol have been executed
	type	boolean
experiment	experiment@id
	related experiment ID
	type	string
_environment	environment
	state that the system is at
	type	object
	properties
	container	_key
		name of the container in which the materials are processed
		type	string
	value	the quantitative and/or qualitative description for the container
		Value
	state	state
		type	object
		properties
		atmosphere	atmosphere
			the type of the atmosphere: glove-box, N2, Ar, ambient
			type	string
		values	the quantitative and/or qualitative description of a system state
			Value
sequence	sequence
	to order the sequence of events in an experiment
	type	object
	properties
	index	order
		the index-step at which this event happened
		type	integer
	_timed	The time this event happened
		Time
class	class
	The class of the event: action or observation
	type	string
	enum	act, obs
action	action
	the action name - a group of allowed names, based on the field (from experiment/user) and class (above)
	type	string
item	Item

Experiment

mosydb/schema/experiment.json
This schema is for describing an experiment at a high level
type	object
properties
@id	experiment @id
	unique ID for an experiment
	type	string
access_control	_key
	who can access the experiment information
	type	string
	enum	group, public
meta	_key
	metadata of an experiment
	type	object
	properties
	contributors	user@id
		the ID of the contributors who designed the experiment
		type	array
	date	date
		the datetime when this protocol was created
		type	number
	editions	_key
		the edition of the experiment - a commit id (GitHub-like)
		type	string
protocol_meta	protocol
	type	object
	properties
	system	system
		the target compound that is made, LiCl, Organic-compound name
		type	string
	category	system category
		the category of the synthesis, e.g,: solid-state, sol-gel, solvent, etc.
		type	string
	motivation	main motivation
		main motivation for the experiment
		type	string
	version	version
		Preferably a number, but can be also a version name
		type	string
	description	description
		a description about the experiment
		type	string
	free_text	free text
		a free text description about the experiment
		type	string
executed	executed
	the executed protocols
	type	object
	properties
	executed	executed
		mark if an experiment was ever executed
		type	boolean
	time	the time an experiment was executed
		Time
	notes	notes
		a note about the experiment - free
		type	string
	events	event@ids
		event id’s
		type	array
	outputs	_key
		output id’s
		type	array

Item

mosydbschema/schema/item.json
For describing and documenting a tool, instrument, or result
type	object
properties
@id	item@id
	unique ID for an item
	type	string
label	_key
	type of item
	type	string
	enum	input, output
input	_key
	an input item
	type	object
	properties
	name	object name
		the name an object
		type	string
	description	description
		a verbal description of an object
		type	string
	link	_key
		linked object
		type	object
		properties
		item	link experiment@id
			internally-related unique ID
			type	string
		url	link external url
			url to the item
			type	string
	value	the quantitative and/or qualitative description of the input
		Value
_output	_key
	an output type
	type	object
	properties
	name	object name
		the name an object
		type	string
	description	description
		a verbal description of an object
		type	string
	link	link
		lined object
		type	object
		properties
		item	link experiment@id
			internally-related unique ID
			type	string
	result	results
		the output results
		type	object
		properties
		user_label	sample label
			the label a user used, eg. in notebook
			type	string
		successful	successful
			whether the result is as expected
			type	string
			enum	unknown, yes, no
		value	the quantitative and/or qualitative description of the result
			Value
		attachment	attachment
			a path to an attachment. Allows a single attachment
			type	string

Person Name

mosydb/schema/helper/personame.json
type	object
properties
first	first name
	first name
	type	string
middle	middle name
	middle name
	type	string
last	last name
	last name
	type	string

Time

mosydb/schema/helper/time.json
The occurrence time of an event
type	object
properties
start_time	start time
	The time an event started
	type	number
end_time	end time
	The time an event ended
	type	number

Value

mosydb/schema/helper/value.json
Describes the measured value of a substance or property
type	object
properties
name	_key
	description of the quantity, e.g. units: temperature, speed, rate, amount, etc.
	type	string
numerical	_key
	type	object
	properties
	value	_key
		type	object
		properties
		planned	quantity-planned
			the planned quantity of the property
			type	number
		actual	quantity-actual
			the planned quantity of the property
			type	number
		actual_list	_key
			a list of planned quantities
			type	array
	units	unit
		the units of the quantity
		type	string
verbal	_key
	qualitative descriptions, e.g. dissolved, clear, opaque, hot, cold, room temperature, steaming
	type	string