Updating Samples
In general, samples should be considered an immutable resource, but how they are shared may be updated by changing their 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.
Additional authorization checks: Note that PATCH
ing 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.
Path Parameters
Body
The project the sample belongs to (optional).
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
Response
"/api/v1/samples/a1b2c3d4e5f67890"
Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.
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