REST API for Oracle Healthcare Translational Research

Retrieve Gene for a Gene Identifier

get

/HSDataService-web/api/3.2.0/genes/{id}

This endpoint supports the retrieval of Gene for a single Gene Row ID passed. It returns Gene information like Gene Name, HUGO Name, Assembly/Alignment, Chromosome and other Gene related information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Gene row ID

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : Gene

Type: object

Properties

assembly: Type: string

Assembly/Alignment Name. For ex.,GRCh38
cancerGenes: Type: object LinkedReference
chromosome: Type: string

Chromosome Name. For ex.,'Y'
chromosomeReference: Type: object LinkedReference
description: Type: string

Gene Description
diseaseGenes: Type: object LinkedReference
drugGenes: Type: object LinkedReference
geneName: Type: string

Gene Name. For ex.,RN5S300
geneReference: Type: object LinkedReference
geneXref: Type: object LinkedReference
genomicPositions: Type: object LinkedReference
hugoName: Type: string

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

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

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

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

400 Response

Invalid parameters supplied

404 Response

Genes not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "GeneDetails",
  "identifier": {
    "system": "ODB",
    "value": "50259"
  },
  "geneName": "ENSG00000146648",
  "hugoName": "EGFR",
  "assembly": "GRCh37",
  "description": "epidermal growth factor receptor [Source:HGNCSymbol;Acc:3236]",
  "genomicPositions": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/genomicPositions"
  },
  "transcripts": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/transcripts"
  },
  "pathways": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/pathways"
  },
  "diseaseGenes": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/diseases"
  },
  "drugGenes": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/drugs"
  },
  "cancerGenes": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/cancer"
  },
  "geneXref": {
    "reference": "/HSDataService-web/api/3.2.0/genes/50259/geneXref"
  }
}