protocols
| Name | protocols.txt |
| JSON File Name | protocols.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The protocol template defines and annotates protocol documents that are to be linked to study, subjects, biological samples or experiments. |
| Download | ⬇️ protocols.xlsx ⬇️ protocols.txt ⬇️ protocols.json This top-level schema references companion files (e.g. protocols.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 protocol user defined ID is an identifier chosen by the data provider to refer to a protocol document. This ID may be referenced by other data records (e.g. study). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| File Name | Required | Text, max 250 characters JSON: fileName (string) | The protocol file name in this column must be an exact spelling match to a file in the ZIP archive that is uploaded. This includes the file extensions which may be hidden depending upon your computer's settings. The file size name limit is 240 characters. The protocol file name is the document uploaded and linked to the protocol ID. The file name must be an exact spelling match including the file extension. The file size name limit is 240 characters. |
| Name | Required | Text, max 250 characters JSON: name (string) | The protocol name is not referenced by other data records. The protocol name is an alternate identifier that is visible when the protocol is shared. |
| Type | Required | Text, max 100 characters Controlled vocabulary — value must be one of lk_protocol_type JSON: type (enum) | The protocol type uses a preferred list of terms to characterize the protocol's content. The protocol type is chosen from a list of preferred terms. |
| Description | Optional | Text, max 4000 characters JSON: description (string) | The summary is a brief description of the protocol's content. The protocol summary describes the purpose of the protocol. |