post

/alleles

This POST request provides a way to retrieve information for one or more variants.

Request Parameters

1 Query Parameter

Request Body

Based on the value provided through parameter file, different types of payloads are expected along with POST request. The simplest one is several HGVS expression separated by newline characters (when file=hgvs).

For example: NC_000017.10:g.43009069G>C NC_000017.10:g.43009090G>T NC_000017.10:g.43009127delG

When value of parameter file is vcf (file=vcf), the payload must be a valid VCF file and must contain a ##contig parameter in the header for every chromosome id used in the file. Moreover each ##contig parameter should contain at least two fields named ‘ID’ and ‘assembly’. The current version of Allele Registry support the following values of ‘ID’ and ‘assembly’ fields: ID: 1-22, X, Y, M, MT, chr1-chr22, chrX, chrY, chrM, chrMT assembly: NCBI36, GRCh37, GRCh38, hg18, hg19

For example: ##fileformat=VCFv4.1 ##contig=<ID=chr17,assembly=GRCh37> #CHROM POS ID REF ALT QUAL FILTER INFO chr17 43009069 . G C 59 PASS DB chr17 43009090 . G T 59 PASS DB chr17 43009126 . AG A 60 PASS DB

When value of parameter file is ca (file=ca), the payload must be series of canonical allele identifiers separated by new line character.

For example: CA000007 CA000008 CA000010 CA000327

3 Examples
Schema
object

Responses

1 Example
Schema
array[object]
@id
string
required
@context
string
required
type
string
required
transcriptAlleles
array[object]
genomicAlleles
array[object]
aminoAcidAlleles
array[object]
externalRecords
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.