Retrieve Variants for Prediction and Gene Identifiers
get
/ohfapi/cg/v3.3/variants/byPrediction/byGenewid
This endpoint supports the retrieval of Variant Identifiers for multiple Gene Identifiers, Assembly/Alignment Identifier, Prediction Type, multiple Prediction Codes, Prediction Score and Prediction Comparator. The response fetches Variants ID(s) which have defined prediction code or score. Both SIFT and PolyPhen (Polymorphism Phenotyping) type data can be searched using this API.
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
- predictionCode(optional): array
-
predictionComparator(optional): string
Prediction Score Comparator( < , > , = )
-
predictionScore(optional): string
Prediction Score .For ex.,1
-
predictionType: string
Prediction Type. for ex.,SIFT
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollection
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 : Serializable
Type:
object
400 Response
Unsupported Prediction Comparator supplied.Supported values are '>','<','='< div>
','='<>
404 Response
Variants not found for the Gene Wids and Prediction details supplied
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/variants/byPrediction/byGenewid?geneWid=731&predictionType=SIFT&predictionCode=deleterious&alignmentId=1&limit=10&offset=0&predictionScore=1&predictionComparator=<
Example of Response Body
The following example shows the response returned in JSON format.
{ "resourceType" : "Variants", "items" : [ { "identifier" : { "system" : "ODB", "value" : "536777" }, "variantPrediction" : { "reference" : "/ohfapi/cg/v3.3/variants/536777/variantPredictions" } }, { "identifier" : { "system" : "ODB", "value" : "536778" }, "variantPrediction" : { "reference" : "/ohfapi/cg/v3.3/variants/536778/variantPredictions" } } ], "count" : 2, "hasMore" : false, "links" : [ { "rel" : "self", "href" : "http://localhost:7010/ohfapi/cg/v3.3/variants/byPrediction/byGenewid?geneWid=731&predictionType=SIFT&predictionCode=deleterious&alignmentId=1&limit=10&offset=0&predictionScore=1&predictionComparator=" } ] }