POST samples instances_init_upload

Request body

external_sample_idstring nullable

An optional external sample ID (see the Metadata resource) to match against pre-uploaded samples. Returns a 400 if no matching sample is found.

filenamestring required

The filename of the sample to be uploaded. FASTA and FASTQ records, optionally gzipped (and ending in .gz or .gzip) are supported. Filenames should only contain alphanumeric characters, dashes, underscores, and periods.

interleavedboolean nullable

Whether the file is interleaved (true) or not (false).

paired_end_filenamestring nullable

Optional filename for paired end uploads.

sample_idstring nullable

An optional sample ID to match against pre-uploaded samples. Returns a 400 if no matching sample is found.

sizeinteger nullable

The size of the file in bytes.

upload_type'standard'

The type of upload to initiate. Currently only standard uploads are supported via the init_upload route.

Example request

{
  "metadata": {
    "external_sample_id": "LIMS-2024-00123"
  },
  "project": {
    "__DOLLAR_REF__": "/api/v1/projects/a1b2c3d4e5f67890"
  }
}

Response

OK

additional_fieldsobject

Additional fields to include in the object storage POST request.

fallback_optionsobject nullable

Fallback options for the upload. Please contact support for help as needed.

paired_end_additional_fieldsobject nullable

Additional fields to include in the object storage POST request for the paired end file (optional).

paired_end_upload_urlstring nullable

Object storage location to POST the paired end file to (optional).

sample_idstring required

The sample ID. Use to confirm the upload.

upload_urlstring required

Object storage location to POST the file to.