POST
/
api
/
v1
/
sequencing
/
batches
/
register
{
  "batch": {
    "$uri": "/api/v1/sequencing/a1b2c3d4e5f67890",
    "batch_number": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "owner": {
      "$ref": "/api/v1/users/a1b2c3d4e5f67890"
    },
    "status": "registered"
  },
  "samples": [
    {
      "sample": {
        "$ref": "<string>"
      },
      "tube_barcode": "<string>"
    }
  ]
}

You can let One Codex know about sequencing samples that are inbound to our lab by registering them as part of a Sequencing Batch. A Batch can have one or more samples associated with it, and lets you associate the tube barcodes for the Reformatting or Sample Collection tubes you have with Sample objects in One Codex.

The response from this endpoint will give you a list of Samples, each with an identifier and the tube barcode it is associated with. You should store this identifier so that you can update Sample metadata or retrieve the Sample later on.

Body

application/json
​
batch_name
string
required

A human-readable name for the sequencing batch.

Required string length: 1 - 100
​
return_tracking_numbers
string[]
required

One or more tracking numbers associated with the sample shipment(s) to the lab.

​
samples
object[]
required

The tube or container barcodes, specimen type, and sequencing depth for each sample to be sequenced.

Response

200 - application/json
Successful operation
​
batch
object
​
samples
object[]