FileFormat

Summary of SMaHT Portal object type FileFormat . Types referencing this type are: AlignedReads, File, HistologyImage, OutputFile, ReferenceFile, SubmittedFile, SupplementaryFile, UnalignedReads, VariantCalls. Property names in red are required properties; those in blue are identifying properties; and properties with types in green are reference properties.

Description: Data format for a file.

Tip

See actual FileFormat data here

Required Properties

Property	Type	Description
identifier	string	See below for more details.
standard_file_extension	string	See below for more details.
valid_item_types	array of enum	See below for more details.
At least one of the following ...
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

Identifying Properties

Property	Type	Description
aliases	array of 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
extra_file_formats	FileFormat 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\\\/]+$
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	-
extra_file_formats	FileFormat • array of string • min items: 1 • unique • restricted	See values here
identifier	string • min length: 2 • unique	Unique, identifying name for the item. Must adhere to (regex) pattern: ^[A-Za-z0-9-_]+$
other_allowed_extensions	array of string • min items: 1 • unique • restricted	Additional allowable extensions for uploading files of this format.
standard_file_extension	string	Standard extension added to files for download.
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|_-]+$
title	string • min length: 3	Title for the item.
uuid	string	Unique ID by which this object is identified.
valid_item_types  • AlignedReads  • HistologyImage  • OutputFile  • ReferenceFile  • SupplementaryFile  • UnalignedReads  • VariantCalls	array of enum • min items: 1 • unique • restricted	Types of items that can utilize this file format.