Retrieve Variants for Variant Effect and Gene Identifiers
get
/ohfapi/cg/v3.3/variants/byEffect/byGenewid
This endpoint supports the retrieval of Variant Identifiers for Variant Effect, multiple Gene Identifiers and Assembly/Alignment Identifier.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
alignmentId: integer(int64)
Minimum Value:
0
Assembly/Alignment ID -
geneWid: array
Collection Format:
multi
Minimum Number of Items:1
Maximum Number of Items:2147483647
Gene ID -
limit(optional): integer(int32)
Number of rows to return
-
offset(optional): integer(int32)
Row number to start from
-
variantEffect: string
Variant Effect
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollectionVariant
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : Variant
Type:
Show Source
object
-
identifier(optional):
object Identifier
Identifier assigned by a given system
-
variantPrediction(optional):
object LinkedReference
Nested Schema : Identifier
Type:
object
Identifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
400 Response
Filter Variants input is not valid
404 Response
Variants not found for the Gene Wids and VariantEffect supplied
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/variants/byEffect/byGenewid?geneWid=6280&geneWid=123&variantEffect=synonymous&alignmentId=1&limit=10&offset=0
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType" : "Variants", "items" : [ { "identifier" : { "system" : "ODB", "value" : "27423" } }, { "identifier" : { "system" : "ODB", "value" : "34705850" } }, { "identifier" : { "system" : "ODB", "value" : "34705852" } }, { "identifier" : { "system" : "ODB", "value" : "34705854" } } ], "count" : 4, "hasMore" : false, "links" : [ { "rel" : "self", "href" : "http://localhost:7010/ohfapi/cg/v3.3/variants/byEffect/byGenewid?geneWid=6280&geneWid=123&variantEffect=synonymous&alignmentId=1&limit=10&offset=0" } ] }