Get Sample File URL - geneyx/geneyx.analysis.api GitHub Wiki

GetSampleFileURL

Geneyx now supports the ability to download the BAM, BAI, and QcMetrics files of a given sample that was processed from the secondary implemented within Geneyx. The files are accessible using the following API infrastructure. This API will provide a URL that will enable download of the requested file. It is important to note that this functionality is subject to fees associated with bandwidth consumption, and should be discussed with your sales representative.

URL:

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

Action:

POST

Payload:

JSON Structure

Requirements:

Category Parameter Description Required
Auth apiUserId The API user Id Yes
apiUserKey The API user key Yes
Sample sampleSn Same as the name given to the VCF file (SampleSerialNumber, sampleId) Yes
fileType BAM, BAI, or QcMetrics Yes

Request

{
  "apiUserId": "enter api user ID
  "apiUserKey": "enter api user key",
  "sampleSn": "10230396_S29_L001.dragen.wes.grch37.20230811-162804",
  "fileType": "BAM"
}

Response

{ “Code”: “success”, “Data”: “https://geneyx-prod-primary-pipeline.s3.eu-west-1.amazonaws.com/8f2c1cc2-0084-4bac-b8b8-86b18937b1e5/sample/240e52b1-4fc4-4457-ac68-a5bb1be741e9/_10230396_S29_L001.dragen.wes.grch37.20230811-162804.bam?X-Amz-Expires=600&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credentials=26GZ322WZG2CO7BY/20230912/eu-west-1/s3/aws4_request&X-Amz-Date=20230912T173429Z&X-Amz-SignedHeaders=host&X-Amz-Signature=49861a5c982a4b50fae1d3e2ad6b9c012258cd2cd8161b4cd0c823a298d”, “Info”: null, “MoreInfo”: null, “NeedEval”: false }

⚠️ **GitHub.com Fallback** ⚠️