experiments

Name	experiments.txt
JSON File Name	experiments.json
Type	single
Schema Version	3.37
Description	The experiments template is a legacy template that defines and annotates the mechanistic assays performed on samples. The function of this template is also captured in the experiment samples template. This template will continue to be supported for the foreseeable future to support backward compatibility.
Download	⬇️ experiments.xlsx ⬇️ experiments.txt ⬇️ experiments.json This top-level schema references companion files (e.g. experiments.Datum.json) in the same json-templates folder — download the all_templates.zip to get them all together.

Reading this table: see How to read the template documentation for what Required / Conditionally required / Optional mean and how to read the Type & Constraints column.

Template Column	Requirement	Type & Constraints	Description
User Defined ID	Required	Text, max 100 characters JSON: userDefinedId (string)	The experiment user defined ID is an identifier chosen by the data provider to refer to an experiment. This ID may be referenced by other data records (e.g. experiment sample, control sample, standard curve). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded.
Name	Required	Text, max 500 characters JSON: name (string)	The experiment name is a display name that is available when the data is shared, but it is not referenced by other data. The experiment name is an alternate identifier that is visible when the sample is shared.
Description	Optional	Text, max 4000 characters JSON: description (string)	The experiment description is used to describe details of the experiment not captured in other columns.
Measurement Technique	Required	Text, max 50 characters Controlled vocabulary — value must be one of lk_exp_measurement_tech JSON: measurementTechnique (enum)	The measurement technique describes the assay method. Choose from a drop down list.
Study ID	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a study JSON: studyId (string)	An experiment may be linked to a single study. Please enter either a study user defined ID or ImmPort accession for the study in which the experiment occurs.
Protocol ID(s)	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a protocol JSON: protocolIds (array)	Please enter either a protocol user defined ID or ImmPort accession. One or more identifiers can be entered per subject. Separate identifiers by semicolon (;).