REST API for Oracle Healthcare Translational Research

Retrieve Genes for a Geneset Identifier

get

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

This endpoint supports the retrieval of Genes by Geneset Row ID.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Gene_set_id value of a geneSet

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

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 GeneSetMembers

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

Type: object

Properties

geneName: Type: string

Gene Name. For ex.,RN5S300
hugoName: Type: string

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

Scientific Species Name

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/geneSets/7

Example of Response Body

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

{
  "resourceType": "GeneSet",
  "items": [
    {
      "hugoName": "CICP27"
    },
    {
      "hugoName": "DDX11L1"
    },
    {
      "hugoName": "FAM138A"
    },
    {
      "hugoName": "MIR1302-10"
    },
    {
      "hugoName": "OR4F5"
    },
    {
      "hugoName": "OR4G11P"
    },
    {
      "hugoName": "OR4G4P"
    },
    {
      "hugoName": "RP11-34P13.7"
    },
    {
      "hugoName": "RP11-34P13.8"
    },
    {
      "hugoName": "WASH7P"
    }
  ],
  "count": 10,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http:localhost:7001/HSDataService-web/api/3.2.0/geneSets/7"
    }
  ]
}