The Sequencing Batch Resource - One Codex Developer Docs

{
  "$uri": "/api/v1/sequencing/batches/0d77065796f8d173",
  "batch_number": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "owner": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  }
}

Sequencing Batches represent sets of samples that are being processed at the One Codex sequencing lab. Batches are what associate physical tubes with Sample objects in One Codex, and help you track samples through the sequencing process. This section includes docs on how to list your sequencing batches, retrieve an individual batch, and register samples to a new batch.

$uri

string

required

read-only

Pattern: ^/api/v1/sequencing/batches/[a-f0-9]{16}$

Example:

"/api/v1/sequencing/batches/0d77065796f8d173"

batch_number

string

required

A unique batch number.

created_at

string<date-time>

required

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

name

string | null

required

A human-readable name for the sequencing batch.

owner

users · object

required

The user that created the sequencing batch.

Show child attributes

status

enum<string>

required

The current status of the sequencing batch.

Available options:

registered,

shipped_to_lab,

received_at_lab,

extracting,

preparing_library,

sequencing,

quality_control,

done,

canceled

Retrieve A User Retrieve All Sequencing Batches