Skip to main content
PATCH
/
api
/
v1
/
samples
/
{id}
{
  "$uri": "/api/v1/samples/a1b2c3d4e5f67890",
  "created_at": "2023-11-07T05:31:56Z",
  "error_msg": "<string>",
  "filename": "<string>",
  "metadata": {
    "$ref": "/api/v1/metadata/a1b2c3d4e5f67890"
  },
  "owner": {
    "$ref": "/api/v1/users/a1b2c3d4e5f67890"
  },
  "primary_classification": {
    "$ref": "/api/v1/classifications/a1b2c3d4e5f67890"
  },
  "project": {
    "$ref": "/api/v1/projects/a1b2c3d4e5f67890"
  },
  "size": 123,
  "status": "awaiting_data",
  "tags": [],
  "updated_at": "2023-11-07T05:31:56Z",
  "visibility": "public"
}
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 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.

Path Parameters

​
id
string
required

Body

application/json
​
project
object

The project the sample belongs to (optional).

​
tags
object[]

An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.

​
visibility
enum<string>

The visibility of the sample (affects who can view the sample and its analyses).

Available options:
public,
shared,
private,
importing,
awaiting data

Response

200 - application/json

Successful operation

​
$uri
string
Example:

"/api/v1/samples/a1b2c3d4e5f67890"

​
created_at
string<date-time>

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

​
error_msg
string | null

An error message if the sample failed to upload, import, or validate.

​
filename
string | null

The sample filename.

​
metadata
object

A metadata object.

​
owner
object

The owner of the sample.

​
primary_classification
object

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.

​
project
object

The project the sample belongs to (optional).

​
size
integer | null

The size of the uploaded file in bytes.

​
status
enum<string>

The status of the sample.

Available options:
awaiting_data,
importing,
validating,
failed_validation,
available,
deleted
​
tags
object[]

An (optionally empty) array of references to Tags describing the sample. Tags are an additional unstructured organizational tool that complement Projects and Metadata records.

​
updated_at
string<date-time>

Timestamp for when the object was last updated, encoded as a RFC 3339 timestamp.

​
visibility
enum<string>

The visibility of the sample (affects who can view the sample and its analyses).

Available options:
public,
shared,
private,
importing,
awaiting data