BatchCases - geneyx/geneyx.analysis.api GitHub Wiki

BatchCases

This API allows the user extract the the cases generated from a batch workflow.

URL:

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

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": [
        {
            "PatientId": "e232b181-92d3-4b8a-bee2-8f26c453d21f",
            "Patient": "Example",
            "SerialNumber": "EG230329071820",
            "Name": "SingleSample panel - V3.0",
            "Description": null,
            "VersionSetId": "fcae09d0-c3ed-4a1c-b2e5-101e70172acc",
            "VersionSetName": "v5.12",
            "VersionSetNumber": 42,
            "VersionSetArchived": false,
            "VersionSetLatest": true,
            "Status": 0,
            "StatusName": "Open",
            "SubStatusId": null,
            "SubStatusName": null,
            "MainSampleId": "6087773a-1681-49d8-979c-9ed416361123",
            "MainSampleSerialNumber": "Example.dragen.wes.hg38.20230329-065438",
            "MainSample": null,
            "MainSampleStats": null,
            "PhenAlleleFreq": 0.001,
            "Phenotypes": "",
            "IsAdvancedPhenotypes": false,
            "Owner": null,
            "OwnerDepartment": null,
            "GeneticModels": [
                1073741824
            ],
            "GeneticModelNames": [
                "Priority Variants"
            ],
            "DefaultGeneticModel": 1073741824,
            "DefaultGeneticModelName": "Priority Variants",
            "ProtocolId": "b21a51d1-bd34-4f9a-b16b-c80d1f5fb423",
            "ProtocolName": "SingleSample panel - V3.0",
            "ProtocolTypeName": "HealthScreening",
            "ProtocolSerialNumber": "Example",
            "AutoAnalyze": true,
            "AutoReport": true,
            "VariantNoteTemplate": null,
            "SortColumn": "Zygosity",
            "SortAsc": true,
            "ExpandColumns": {
                "Score": true,
                "MatchedPhenotypes": true,
                "COSMIC": true,
                "MitoEvidence": true
            },
            "CalcLocalFreq": true,
            "LocalFreqDate": "2023-03-29T07:48:43.817",
            "LocalFreqSamples": 500,
            "LocalFreqSvSamples": 502,
            "AccountGroupFreqSamples": null,
            "UnfilterEvidence": false,
            "GeneList": null,
            "Disease": null,
            "ReadyForAnalysis": false,
            "SamplesReady": false,
            "HasAnalysis": true,
            "HasReport": false,
            "VariantMapId": "4a3df9d3-a70d-4502-8f39-728650d72ce6",
            "VariantMapName": "VariantMap",
            "GenomeBuild": 1,
            "AcmgCalcDate": null,
            "IbdParentsCalcStatus": "None",
            "AssociatedSamples": null,
            "Assignment": null,
            "IsTrio": false,
            "ID": "c10a533d-ebc8-4047-b31e-9a17b7a090e7",
            "CreatedByUser": "GeneyxSupport",
            "CreateDate": "2023-03-29T07:18:20.423",
            "ModifiedByUser": "GeneyxSupport",
            "ModifyDate": "2023-03-29T07:18:20.423"
        },
⚠️ **GitHub.com Fallback** ⚠️