Get variant file download ticket
GET /variants/{id}
Gets an htsget ticket containing URLs that will enable the transfer of a requested variant file
Parameters
Path Parameters
Read or variant object identifier
Query Parameters
Desired variant file format
Example
VCFRequest different classes of data. By default, i.e., when class is not specified, the response will represent a complete read or variant data stream, encompassing SAM/CRAM/VCF headers, body data records, and EOF marker
Example
headerReference sequence name
chr1The start position of the range on the reference, 0-based, inclusive
12312The end position of the range on the reference, 0-based, exclusive
99999Responses
200
Successfully retrieved htsget ticket
object
Contains htsget ticket attributes that will enable genomic file transfer
object
The format of the returned file
An array of URLs and headers that, when requested, will transfer individual file parts of a requested genomic file
A URL and associated headers that, when requested, perform transfer of a requested file
object
Data transfer URL
https://htsget.ga4gh.org/reads/data/object00001?referenceName=chr1Headers that must be supplied in the request to a data transfer URL
object
When supplied to the data transfer URL, indicates whether a header or body file part is to be returned
headerIndicates the file part’s position within the overall downloaded file
0Indicates how many file parts the overall genomic file transfer has been broken into
100Path to a local file that is to be streamed on simple byte indices
/data/reads/object00001.bamThe start/end byte positions of the file to be streamed
bytes=0-500000Indicates whether the url is responsible for downloading the requested file header or body
ID of the htsget object
object
VCFobject
Data transfer URL
https://htsget.ga4gh.org/reads/data/object00001?referenceName=chr1Headers that must be supplied in the request to a data transfer URL
object
When supplied to the data transfer URL, indicates whether a header or body file part is to be returned
headerIndicates the file part’s position within the overall downloaded file
0Indicates how many file parts the overall genomic file transfer has been broken into
100Path to a local file that is to be streamed on simple byte indices
/data/reads/object00001.bamThe start/end byte positions of the file to be streamed
bytes=0-500000Indicates whether the url is responsible for downloading the requested file header or body
https://htsget.ga4gh.org/variants/data/00001object
When supplied to the data transfer URL, indicates whether a header or body file part is to be returned
headerIndicates the file part’s position within the overall downloaded file
0Indicates how many file parts the overall genomic file transfer has been broken into
100Path to a local file that is to be streamed on simple byte indices
/data/reads/object00001.bamThe start/end byte positions of the file to be streamed
bytes=0-500000/data/variants/object00001.vcf400
The request was not processed, as the request parameters did not adhere to the specification
object
Error object container
object
Name/type of the error that occurred
ServerErrorMessage explaining why the error occurred
An unspecified server error occurredobject
InvalidInput'FOO' is not an acceptable field404
The request was not processed, as the requested object was not found
object
Error object container
object
Name/type of the error that occurred
ServerErrorMessage explaining why the error occurred
An unspecified server error occurredobject
NotFoundThe requested resource could not be located5XX
Unspecified server error encountered
object
Error object container
object
Name/type of the error that occurred
ServerErrorMessage explaining why the error occurred
An unspecified server error occurred