Retrieve Variants for Chromosome
get
/HSDataService-web/api/3.2.0/variants/byChromosome
This endpoint supports the retrieval of Variant Identifiers for Chromosome, Start Position, End Position and Assembly/Alignment Identifier.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
- alignmentId
-
Type:
integer
(int64
)Required:true
Assembly/Alignment ID- chromosome
Type:string
Required:true
Chromosome Name. For ex.,'Y'- endPosition
Type:integer
(int64
)Required:true
Chromosome End Position- limit
Type:integer
(int32
)Number of rows to return- offset
Type:integer
(int32
)Row number to start from- startPosition
Type:integer
(int64
)Required:true
Start location of sequenceResponse
Supported Media Types- application/json
- application/xml
200 Responsesuccessful operationBodyModel for paginated collections of data.Root Schema : PageableCollectionVariantType:object
Model for paginated collections of data.- count
-
Type:
integer
(int64
)Number of objects in the 'items' collection. - hasMore
-
Type:
boolean
Default Value:false
A boolean indicating if more pages are available. - items
-
Type:
array
itemsA collection of paged items. - links
-
Type:
array
linksA collection of links containing hrefs to the current, next, and previous pages as applicable. - resourceType
-
Type:
string
Identify the resource type
Nested Schema : linksNested Schema : VariantType:object
- identifier
-
Type:
object
IdentifierIdentifier assigned by a given system - variantPrediction
-
Type:
object
LinkedReference
Nested Schema : IdentifierType:object
Identifier assigned by a given system- system
-
Type:
string
System which assigned this identifier - value
-
Type:
string
Identifier value
Nested Schema : LinkedReferenceType:object
- display
-
Type:
string
- reference
-
Type:
string
400 ResponseFilter Variants input is not valid404 ResponseVariants not found for the Chromosome suppliedExamples
The following example submits a GET request.
API URL
http://localhost:7001/HSDataService-web/api/3.2.0/variants/byChromosome?alignmentId=1&chromosome=CHR20&startPosition=3&endPosition=4&limit=10&offset=0
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType" : "Variants", "items" : [ { "identifier" : { "system" : "ODB", "value" : "62935268" } }, { "identifier" : { "system" : "ODB", "value" : "62935272" } }, { "identifier" : { "system" : "ODB", "value" : "62935293" } } ], "count" : 3, "hasMore" : false, "links" : [ { "rel" : "self", "href" : "http://localhost:7001/HSDataService-web/api/3.2.0/variants/byChromosome?alignmentId=1&chromosome=CHR20&startPosition=3&endPosition=4" } ] }