REST API for Oracle Healthcare Translational Research

Retrieve Transcripts for a Gene Identifier

get

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

This endpoint supports the retrieval of Transcripts for a Gene Row ID passed. It returns Transcript information like Transcript Identifier, Protein Name, Accession and Ensembl Version.

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

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 Transcript

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

Type: object

Properties

componentTypes: Type: array componentTypes

List of Component Types
transcriptId: Type: string

Transcript ID

Nested Schema : componentTypes

Type: array

List of Component Types

Items

Type: string

400 Response

Invalid parameters supplied

404 Response

Gene transcript(s) not found

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

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

{
  "resourceType": "Transcripts",
  "items": [
    {
      "transcriptId": "ENST00000275493",
      "proteinName": "EGFR_HUMAN",
      "accession": "P00533; O00688; O00732; P06268; Q14225; Q68GS5; Q92795; Q9BZS2; Q9GZX1; Q9H2C9; Q9H3C9; Q9UMD7; Q9UMD8; Q9UMG5;",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000459688",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000485503",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000344576",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000420316",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000342916",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000455089",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000450046",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000454757",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000463948",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "transcriptId": "ENST00000442591",
      "ensemblVersion": "GRCH37.75",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 11,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/transcripts"
    }
  ]
}