BeaconAlleleRequest [beacon-v2]

{S}[B] Status Level [i]
playground
Provenance
Used by
Contributors
Source (2.0.0-draft.1)

Attributes

Type: object
Description: Allele request made against the beacon. The allele must be mapped against a sequence in a genome, and a range can be optionally specified.

Properties

Property Type
alternateBases ./AlternateBases [HTML]
assemblyId string
datasetIds array of "string"
end integer
endMax integer
endMin integer
includeDatasetResponses string
mateName ./Chromosome [HTML]
referenceBases ./ReferenceBases [HTML]
referenceName ./Chromosome [HTML]
start integer (int64)
startMax integer
startMin integer
variantType string

alternateBases

assemblyId

Assembly identifier (GRC notation, e.g. GRCh37).

datasetIds

Identifiers of datasets, as defined in BeaconDataset. If this field is null/not specified, all datasets should be queried.

end

Precise end coordinate (0-based, exclusive). See start.

endMax

Maximum end coordinate. See startMin.

endMin

Minimum end coordinate. See startMin.

includeDatasetResponses

Indicator of whether responses for individual datasets (datasetAlleleResponses) should be included in the response (BeaconAlleleResponse) to this request or not. If null (not specified), the default value of NONE is assumed.

mateName

referenceBases

referenceName

start

Precise start coordinate position, allele locus (0-based, inclusive).

startMax

Maximum start coordinate. See startMin.

startMin

Minimum start coordinate

variantType

The variantType is used to denote e.g. structural variants.

Examples:

Optional: either alternateBases or variantType is required.


2020-05-25