Protocol
Summary of SMaHT Portal object type Protocol . Types referencing this type are: Analyte, CellCulture, CellCultureMixture, CellCultureSample, CellSample, FileSet, Library, Sample, SampleSource, Sequencing, TissueCollection, TissueSample. Property names in red are required properties; those in blue are identifying properties; and properties with types in green are reference properties.Tip
See actual Protocol data hereRequired Properties
| Property | Type | Description |
|---|---|---|
| identifier | string | See below for more details. |
| submission_centers | SubmissionCenter array of string | See below for more details. See values here |
| version | string | See below for more details. |
Identifying Properties
| Property | Type | Description |
|---|---|---|
| accession | string | See below for more details. |
| identifier | string | See below for more details. |
| uuid | string | See below for more details. |
Reference Properties
| Property | Type | Description |
|---|---|---|
| consortia | Consortium array of string | See below for more details. See values here |
| submission_centers | SubmissionCenter array of string | See below for more details. See values here |
Properties
| Property | Type | Description |
|---|---|---|
| accession | string | A unique identifier to be used to reference the object. [Only admins are allowed to set or update this value.] |
| alternate_accessions | array of string • restricted | Accessions previously assigned to objects that have been merged with this object. [Only admins are allowed to set or update this value.] |
| attachment | object | File attached to this Item. |
| attachment . blob_id | string | - |
| attachment . download | string | File Name of the attachment. |
| attachment . height | integer | Height of the image attached, in pixels. |
| attachment . href | string | Path to download the file attached to this Item. [Internal webapp URL for document file] |
| attachment . md5sum | string | Use this to ensure that your file was downloaded without errors or corruption. |
| attachment . size | integer | Size of the attachment on disk. |
| attachment . type • application/msword • application/pdf • application/proband+xml • application/vnd.ms-excel • application/vnd.openxmlformats-o fficedocument.spreadsheetml.sheet • application/zip • image/gif • image/jpeg • image/png • image/svs • image/tiff • text/autosql • text/html • text/plain • text/tab-separated-values | enum of string | - |
| attachment . width | integer | Width of the image attached, in pixels. |
| consortia | Consortium • array of string • unique | Consortia associated with this item. See values here |
| description | string | Plain text description of the item. |
| display_title | string • calculated | - |
| identifier | string • min length: 2 • unique | Unique, identifying name for the item. Must adhere to (regex) pattern: ^[A-Za-z0-9-_]+$ |
| status • deleted • draft • in review ← default • obsolete • public • released • restricted | enum of string • default: in review | - |
| submission_centers | SubmissionCenter • array of string • unique | Submission Centers that created this item. See values here |
| tags | array of string • min string length: 1 • max string length: 50 • unique • restricted | Key words that can tag an item - useful for filtering. Must adhere to (regex) pattern: ^[a-zA-Z0-9|_-]+$ |
| uuid | string | Unique ID by which this object is identified. |
| version | string | Version for the item. Must adhere to (regex) pattern: ^([0-9]+.)*[0-9]+$ |