reagent_sets
| Name | Reagent_Sets.txt |
| JSON File Name | Reagent_Sets.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The reagent set template defines and annotates the groups of reagents that are used together in assays such as flow cytometry panels, or multiplex ELISA assays. This template is optional. |
| Download | ⬇️ Reagent_Sets.xlsx ⬇️ Reagent_Sets.txt ⬇️ Reagent_Sets.json This top-level schema references companion files (e.g. Reagent_Sets.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 reagent user defined ID is an identifier chosen by the data provider to refer to an assay reagent. The nature of the assay reagent is assay specific and may be an array, an antibody or a typing kit. This ID may be referenced by other data records (e.g. experiment sample). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Reagent ID(s) | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a reagentJSON: reagentIds (array) | The individual reagents are defined in assay specific reagent templates (e.g. flow cytometry, ELISA). The data provider may define a set or panel of reagents used in a single assay (e.g a panel of fluorochrome conjugated monoclonal antibodies). Provide a list of individual reagents that comprise the reagent set. Separate the individual reagent IDs with a semi-colon. |
| Description | Required | Text, max 4000 characters JSON: description (string) | The assay reagent description provides further details on the nature and purpose of the reagent. A supplemental description of the assay reagent that expands on its Name and User Defined ID. |
| Name | Required | Text, max 200 characters JSON: name (string) | The reagent name is not referenced by other data records. The reagent name is an alternate ID that is shared. |
| Type | Required | Text, max 50 characters Controlled vocabulary — value must be one of lk_reagent_type JSON: type (enum) | The reagent set type indicates the assay type with which the reagent set is used. Choose from a list of preferred assay types. |