REST API for Oracle Healthcare Translational Research

Retrieve Genes for a HUGO Name

get

/HSDataService-web/api/3.2.0/genes/byHugoName/{name}/{alignmentId}

This endpoint supports the retrieval of Genes for a single HUGO Name and Assembly/Alignment 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

alignmentId: Type: integer (int64)

Required: true

AlignmentWid
name: Type: string

Required: true

Approved HUGO symbol for species loci, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.

Query Parameters

limit: Type: integer (int32)

Number of rows to return
offset: Type: integer (int32)

Row number to start from

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionGene

Type: object

Model for paginated collections of data.

Properties

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 items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object Gene

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested 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(s) not found

Examples

The following example submits a GET request.

API URL

 http://localhost:7001//HSDataService-web/api/3.2.0/genes/byHugoName/BID/1

Example of Response Body

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

{
  "resourceType": "Genes",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "22797"
      },
      "geneName": "ENSG00000015475",
      "hugoName": "BID",
      "assembly": "GRCh37",
      "chromosome": "22",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/22797"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/byHugoName/BID/1"
    }
  ]
}