Document
Summary of SMaHT Portal object type Document . Property names in red are required properties; those in blue are identifying properties; and properties with types in green are reference properties.Description: Data content and metadata, typically for simple files (text, pdf, etc.).
Tip
See actual Document data hereIdentifying Properties
| Property | Type | Description |
|---|---|---|
| aliases | array of 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 |
|---|---|---|
| aliases | array of string • unique • restricted | Institution-specific ID (e.g. bgm:cohort-1234-a). Must adhere to (regex) pattern: ^[^\s\\\/]+:[^\s\\\/]+$ |
| 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 | - |
| 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 |
| uuid | string | Unique ID by which this object is identified. |