BatchReportList - geneyx/geneyx.analysis.api GitHub Wiki

BatchReportList

This API allows the user extract the reports generated with from a Batch Upload of samples.

URL:

https://analysis.geneyx.com/api/BatchReportList

Action:

POST

Payload:

JSON Structure

Requirements:

Category Parameter Description Required
Auth ApiUserId The API user Id Yes
ApiUserKey The API user key Yes
Subject batchName This is the Batch File Name assigned by Geneyx to the uploaded file. Yes

Request

{
  "batchName": "BatchImportWorkflowBatchVal_2023_03_29.Txt-20230329-065038",
  "ApiUserId": "enter API USer ID",
  "ApiUserKey": "Enter API User Key"
}

Response

{
    "Code": "success",
    "Data": [
        {
            "ID": "1ce05cea-b9e4-4e38-a417-80ee726f07f7",
            "ReportFileUrl": "EG230329071903 - SingleSample panel - V3.0 - 230329_1720.pdf",
            "DataFileUrl": "EG230329071903 - SingleSample panel - V3.0 - 230329_1720 - data.xlsx",
            "Summary": null,
            "CreatedByUser": "Geneyx Support",
            "CreateDate": "2023-03-29T17:20:02.137",
            "PatientSn": "CV24b1",
            "PatientName": null,
            "CaseSn": "EG230329071903",
            "CaseName": "SingleSample panel - V3.0",
            "SampleSn": "CV24b1.dragen.wes.hg38.20230329-065459",
            "SampleVcfUrl": "CV24b1.dragen.wes.hg38.20230329-065459.vcf.gz"
        }
    ],
    "Info": null,
    "MoreInfo": null,
    "NeedEval": false
}
⚠️ **GitHub.com Fallback** ⚠️