REST API for Oracle Healthcare Translational Research

Retrieve Variant Predictions for a Variant Identifier

get

/HSDataService-web/api/3.2.0/variants/{id}/variantPredictions

This endpoint supports the retrieval of Variant Predictions for Variant Identifier. It returns Variant Prediction information like HUGO Name, Transcript Identifier, Assembly/Alignment, Ensembl Version, Prediction Type, Prediction Code, Prediction Version and other Variant Prediction associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Variant Row ID

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : VariantPrediction

Type: object

Properties

gene: Type: array gene

List of Gene Predictions
identifier: Type: object Identifier

Identifier assigned by a given system
resourceType: Type: string
variantReferences: Type: object LinkedReference

Nested Schema : gene

Type: array

List of Gene Predictions

Items

Type: object GenePrediction

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : GenePrediction

Type: object

Properties

hugoName: Type: string

Approved HUGO symbol for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.
variantPredictions: Type: array variantPredictions

List of Predictions

Nested Schema : variantPredictions

Type: array

List of Predictions

Items

Type: object Prediction

Nested Schema : Prediction

Type: object

Properties

assembly: Type: string

Assembly/Alignment Name. For ex.,GRCh38
ensemblVersion: Type: string

Ensembl Version. For ex.,GRCH37.75
predictionCode: Type: string

Prediction Code. For ex.,deleterious
predictionScore: Type: number

Prediction Score .For ex.,1
predictionType: Type: string

Prediction Type. for ex.,SIFT
predictionVersion: Type: string

Prediction Version Label. For ex.,SIFT_VER2_75
transcriptId: Type: string

Transcript ID. For.,ENST00000441069
variant: Type: object LinkedReference

400 Response

Invalid parameters supplied

404 Response

Variant prediciton(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/variants/536777/variantPredictions

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "VariantPredictions",
  "identifier": {
    "system": "ODB",
    "value": "536777"
  },
  "gene": [
    {
      "hugoName": "ASAP3",
      "variantPrediction": [
        {
          "transcriptID": "ENST00000437606",
          "assembly": "GRCh37",
          "ensemblVersion": "GRCH37.75",
          "predictionType": "SIFT",
          "predictionCode": "deleterious",
          "predictionScore": 0,
          "predictionVersion": "SIFT_VER2_75"
        },
        {
          "transcriptID": "ENST00000492982",
          "assembly": "GRCh37",
          "ensemblVersion": "GRCH37.75",
          "predictionType": "SIFT",
          "predictionCode": "deleterious",
          "predictionScore": 0,
          "predictionVersion": "SIFT_VER2_75"
        }
      ]
    }
  ],
  "variant": {
    "reference": "/HSDataService-web/api/3.2.0/HSDataService-web/api/3.2.0/variants/536777"
 }