visibility and project properties and the tags associated with them may also be changed. All other sample attributes are read-only, and the associated metadata record should be used for storing additional (mutable) structured information about a sample.
PATCHing to update the sample’s visibility triggers additional account- and organization-level checks. For certain accounts (e.g., those in which PII is deposited), it may not be possible to make samples shared or public. Please contact us to discuss setting additional restrictions on sample-sharing for your or your organization’s account. Similarly, users may only add their samples to projects for which they have appropriate project-level permissions.Enum for the v1 API visibility attribute.
Note: this is legacy and only exists for backwards-compatibility in the public v1 API.
public, shared, private, importing, awaiting data OK
^/api/v1/samples/[a-f0-9]{16}$"/api/v1/samples/0d77065796f8d173"
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.
Enum for user-facing data status.
This is a subset of DataStatus for the status attribute in the APIs.
awaiting_data, importing, validating, failed_validation, available, deleted Enum for the v1 API visibility attribute.
Note: this is legacy and only exists for backwards-compatibility in the public v1 API.
public, shared, private, importing, awaiting data An error message if the sample failed to upload, import, or validate.
The sample filename.
The project the sample belongs to (optional).
The size of the uploaded file in bytes.
An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.