UpdateSampleQc - geneyx/geneyx.analysis.api GitHub Wiki

UpdateSampleSequencingQc

This script is used to update the sample qc data.

URL:

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

China Domain:

https://fa.shanyint.com/api/UpdateSampleQc

Action:

POST

Payload:

JSON Structure

Table

Category Parameter Description Required
Auth ApiUserId The API user Id Yes
ApiUserKey The API user key Yes
Sample SampleSerialNumber The VCF serial ID Yes
SampleTakenDate Sample taken date yyyy/mm/dd No
SampleSequenceDate Sample sequencing date yyyy/mm/dd No
SampleReceivedDate Sample Received Dateyyyy/mm/dd No
SampleType May be one of the following: RnaSeq, DnaSeq No
SampleTarget May be one of the following: WholeGenome, Exome, GenePanel, TargetRegion No
SampleSource May be one of the following: Germline, Tumor, Blood, Buccal, Fetal, Saliva, Other No
SampleNotes Sample Notes No
SampleGenomeBuild Maybe one of the following: hg19, hg38 No
SampleQcData Sample QC Data, such as gene coverage, in JSON format No
SubjectName Name of Subject No
SubjectGender M, or F No
SubjectDateOfBirth Date of birth of subject yyyy/mm/dd No
SampleNotes Sample Notes No
SubjectHasBioSample Bio sample available No
SubjectUseConsentPersonal Personal consent No
SubjectUseConsentClinical Clinical consent No
SkipAnnotation true or false, will not annotate the sample if true No

Example

{
  "SampleSerialNumber": "DNA23644.dragen.wgs.hg38.20220904-211745",
  "SampleTakenDate": "2022-12-27",
  "SampleSequenceDate": "2022-12-27",
  "SampleReceivedDate": "2022-12-27",
  "SampleType": "Blood",
  "SampleTarget": "exome",
  "SampleSource": "germline",
  "SampleNotes": "Clinical description",
  "SampleGenomeBuild": "hg19",
  "SampleQcData": "{\"genes\": {\"AARS1\": 100.0, \"ZNF469\": 100.0, \"ZNF513\": 100.0, \"ZNF526\": 100.0, \"ZNF592\": 100.0,\"ZSWIM6\": 96.84}}",
  "SubjectId": " DNA23644",
  "SubjectName": "Example",
  "SubjectGender": "Male",
  "SubjectDateOfBirth": "2022-12-27",
  "SubjectHasBioSample": true,
  "SubjectUseConsentPersonal": true,
  "SubjectUseConsentClinical": true,
  "SkipAnnotation": true,
  "ApiUserId": "xxx",
  "ApiUserKey": "xxx"
}

Response

{
    "Code": "success",
    "Data": "Done",
    "Info": null,
    "MoreInfo": null,
    "NeedEval": false
}
⚠️ **GitHub.com Fallback** ⚠️