Example Response¶

The following example shows the JSON response returned by the Sample API for a request containing a single run ID.

Request: GET /mave/sample/v1?run_ids=50955&limit=100&offset=0

{
  "samples": [
    {
      "id_study_lims": "12345",
      "id_run": 50955,
      "name": "Sample_001",
      "supplier_name": "SUPP_001",
      "sequencing_technology": "element",
      "irods_root_collection": "/seq/warehouse",
      "irods_data_relative_path": "runs/50955/sample_001.fastq.gz",
      "paired_read": 1,
      "num_reads": 16284795,
      "lane": 2
    },
    {
      "id_study_lims": "12345",
      "id_run": 50955,
      "name": "Sample_002",
      "supplier_name": "SUPP_002",
      "sequencing_technology": "element",
      "irods_root_collection": "/seq/warehouse",
      "irods_data_relative_path": "runs/50955/sample_002.fastq.gz",
      "paired_read": 1,
      "num_reads": 16284795,
      "lane": 3
    }
  ],
  "limit": 100,
  "offset": 0,
  "count": 2
}

Key points:

• samples is an array containing one object per sample record returned from MLWH.
• num_reads is the number of sequencing reads associated with a sample for a given run/lane
• paired_read: 1 indicates both samples used paired-end sequencing.
• lane differs between samples — multiple samples from the same run may be spread across different lanes.
• irods_data_relative_path gives the path to the sequencing data file relative to irods_root_collection.
• sequencing_technology: "element" identifies the sequencing platform used.
• count: 2 confirms two records were returned, which is consistent with the result set for this run.
• limit and offset reflect the pagination parameters applied to the query.

Multi-Run Example¶

Request: GET /mave/sample/v1?run_ids=50955&run_ids=50956

When multiple run IDs are supplied, the response contains sample records for all matching runs interleaved in a single samples array. The count reflects the total number of records returned across all supplied run IDs.