Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.onecodex.com/llms.txt

Use this file to discover all available pages before exploring further.

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
Pattern: ^/api/v1/sequencing/batches\/[^/]+$
Example:

"/api/v1/sequencing/a1b2c3d4e5f67890"

​
batch_number
string

A unique batch number.

​
created_at
string<date-time>

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

​
name
string

A human-readable name for the sequencing batch.

​
owner
object

The user that created the sequencing batch.

​
status
enum<string>

The current status of the sequencing batch.

Available options:
registered,
shipped_to_lab,
received_at_lab,
extracting,
preparing_library,
done,
canceled