public
, shared
, or private
(no icon or if owner by another user and shared via a private project). The visibility of a sample controls access to a sample resource, any analyses (and corresponding jobs) performed on that sample, as well as the sample’s metadata, project, and tags. As such, sensitive samples should always be “private” and shared across accounts using private projects.
importing
until One Codex’s servers have successfully retrieved the file. These samples are always private to the owner
of the sample."/api/v1/samples/a1b2c3d4e5f67890"
An error message if the sample failed to upload, import, or validate.
The sample filename.
A metadata object.
The owner of the sample.
A reference to a Classification for the sample. This will typically be the One Codex Database or Targeted Loci Database results as appropriate. Note that samples will not have a primary_classification
while they are still importing or being uploaded.
The project the sample belongs to (optional).
The size of the uploaded file in bytes.
The status of the sample.
awaiting_data
, importing
, validating
, failed_validation
, available
, deleted
An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.
The visibility of the sample (affects who can view the sample and its analyses).
public
, shared
, private
, importing
, awaiting data