REST API for Oracle Healthcare Translational Research

Retrieve Gene References for a Gene Identifier

get

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

This endpoint supports the retrieval of Gene References for a Gene Row ID passed. It returns Gene Reference information like Reference Identifier, Database, DNA Reference Version and other Gene Reference associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

gene row ID

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 : PageableCollectionGeneReference

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 GeneReference

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 : GeneReference

Type: object

Properties

database: Type: string

Database Name. For ex.,dbSNP_142
dnaReferenceVersion: Type: string

Version Label. For ex.,SIFT_VER2_75
geneRef: Type: object LinkedReference
identifier: Type: object OdbIdentifier

Identifier assigned by a given system
referenceId: Type: string

Reference ID to External Database. For ex.,rs13079411

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : OdbIdentifier

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

GeneXRef data not found

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

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

{
  "resourceType": "GeneXRef",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "29966"
      },
      "referenceId": "ENSG00000146648",
      "database": "EMBL",
      "dnaReferenceVersion": "GRCH37.75",
      "geneRef": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "239940"
      },
      "referenceId": "EGFR",
      "database": "locus_tag",
      "dnaReferenceVersion": "GRCH37.75",
      "geneRef": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/geneXref"
    }
  ]
}