BeaconCnvRequest [beacon ]

{S}[B] Status [i]
proposed
Provenance
Used by
Contributors
Source (v1.1.0)

Attributes

Type: object
Description: CNV request against Beacon resources.

TODO: The documented queries will fail current tests due to the lack of the referenceBases parameter.

Properties

Property Type
assemblyId string
datasetIds array of string
endMax integer (int64)
endMin integer (int64)
includeDatasetResponses string
referenceName https://beacon-project.io/schemas/beacon/v1.1.0/Chromosome.json [SRC] [HTML]
startMax integer (int64)
startMin integer (int64)
variantType string

assemblyId

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

assemblyId Value Example
"GRCh38"

datasetIds

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

datasetIds Value Example
[
   "arraymap",
   "TCGA"
]

endMax

Maximum end coordinate. See startMin.

endMax Value Examples
344452
244238579

endMin

Minimum end coordinate. See startMin.

endMin Value Examples
34
244238578

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.

includeDatasetResponses Value Example

referenceName

Chromosome as string

referenceName Value Examples
"22"
"Y"

startMax

Maximum start coordinate. See startMin.

startMax Value Examples
6298006
243998770

startMin

Minimum start coordinate

startMin Value Examples
0
6298005

variantType

The variantType is used to denote the type of structural variant.

Use in BeaconCnvRequest:

variantType Value Examples
"DUP"
"DEL"

BeaconCnvRequest Value Example

{
   "assemblyId" : "GRCh38",
   "datasetIds" : [
      "arraymap",
      "progenetix"
   ],
   "endMax" : "26000000",
   "endMin" : "21967753",
   "referenceName" : "9",
   "startMax" : "21975098",
   "startMin" : "18000000",
   "variantType" : "DEL"
}