POST sequencing instances_batches_register

post/api/v1/sequencing/batches/register

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/sequencing/batches/register
  • Auth
    API key in header X-API-Key

Request body

batch_namestring required

A human-readable name for the sequencing batch.

return_tracking_numbersstring[] required

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

Response

OK

Example response

{
  "batch": {
    "$uri": "/api/v1/sequencing/batches/0d77065796f8d173",
    "owner": {
      "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
    }
  },
  "samples": [
    {
      "sample": {
        "__DOLLAR_REF__": "/api/v1/samples/a1b2c3d4e5f67890"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.