REST API for Oracle Healthcare Translational Research

Retrieve Genes for Geneset Identifiers

get

/HSDataService-web/api/3.2.0/genes/byGeneSet

This endpoint supports the retrieval of Genes for multiple Geneset Row IDs 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

Query Parameters

alignmentId

Type: integer (int64)

Required: true

Alignment row ID

id

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Geneset row ID

Items

Type: integer (int64)

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/byGeneSet?id=10&id=1&id=2&alignmentId=1&limit=10&offset=0

Example of Response Body

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

{
  "resourceType": "Genes",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "2"
      },
      "geneName": "ENSG00000223972",
      "hugoName": "DDX11L1",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/2"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "3"
      },
      "geneName": "ENSG00000227232",
      "hugoName": "WASH7P",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/3"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "4"
      },
      "geneName": "ENSG00000243485",
      "hugoName": "MIR1302-10",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/4"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "5"
      },
      "geneName": "ENSG00000237613",
      "hugoName": "FAM138A",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/5"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "6"
      },
      "geneName": "ENSG00000268020",
      "hugoName": "OR4G4P",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/6"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "7"
      },
      "geneName": "ENSG00000240361",
      "hugoName": "OR4G11P",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/7"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "8"
      },
      "geneName": "ENSG00000186092",
      "hugoName": "OR4F5",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/8"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "9"
      },
      "geneName": "ENSG00000238009",
      "hugoName": "RP11-34P13.7",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/9"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "10"
      },
      "geneName": "ENSG00000239945",
      "hugoName": "RP11-34P13.8",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/10"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "11"
      },
      "geneName": "ENSG00000233750",
      "hugoName": "CICP27",
      "assembly": "GRCh37",
      "chromosome": "1",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/11"
      }
    }
  ],
  "count": 10,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/byGeneSet?id=10&id=1&id=2&alignmentId=1&limit=10&offset=0"
    }
  ]
}