GET
/
api
/
v1
/
samples
/
public
[
  {
    "$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"
  }
]

GET all publicly-listed samples. Returns a paginated list of Samples.

Query Parameters

​
page
integer
default:1

Page number. Defaults to 1. See Pagination for more details.

​
per_page
integer
default:50

Number of requested paginated records. Defaults to 50. See Pagination for more details.

​
sort
object

Optional Mongo-style JSON sort clause, e.g., sort={"created_at": true} to sort by created_at (descending)

​
where
object

Optional Mongo-style JSON filter clause, e.g., where={"$uri": {"$eq": "/api/v1/samples/0ee172af60e84f61"}}

Response

200 - application/json
Successful operation
​
$uri
string
Example:

"/api/v1/samples/a1b2c3d4e5f67890"

​
created_at
string

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

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