REST API for Oracle Healthcare Translational Research

Retrieve CDS Components for a Gene Identifier and Structure Identifier

get

/HSDataService-web/api/3.2.0/genes/{id}/{structure}/components/CDS

This endpoint supports the retrieval of CDS Components for a Gene Row ID and Structure Row ID passed. It returns CDS Component information like Gene name, Ensembl Version, Transcript Identifier, Component Name, Component Identifier, Genomic Positions, Strand and other CDS Component associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

gene row ID
structure: Type: integer (int64)

Required: true

structure 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 : PageableCollectionGeneComponentSource

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 GeneComponentSource

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

Type: object

Properties

componentSource: Type: object Transcript
ensemblVersion: Type: string

Ensembl Version. For ex.,GRCH37.75
geneName: Type: string

Gene Name. For ex.,RN5S300
geneReference: Type: object LinkedReference
identifier: Type: object Identifier

Identifier assigned by a given system

Nested Schema : Transcript

Type: object

Properties

componentTypes: Type: array componentTypes

List of Component Types
transcriptId: Type: string

Transcript ID

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

Nested Schema : componentTypes

Type: array

List of Component Types

Items

Type: string

400 Response

Invalid parameters supplied

404 Response

Gene CDS component(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/225738/components/CDS

Example of Response Body

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

{
  "resourceType": "GeneComponents",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "225738"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "componentName": "CDS",
            "componentId": 1193269,
            "genomicPosition": [
              {
                "chromosome": "7",
                "startPosition": 55086971,
                "endPosition": 55087058,
                "strand": "+",
                "numberInSequence": 1
              },
              {
                "chromosome": "7",
                "startPosition": 55209979,
                "endPosition": 55210130,
                "strand": "+",
                "numberInSequence": 2
              },
              {
                "chromosome": "7",
                "startPosition": 55210998,
                "endPosition": 55211181,
                "strand": "+",
                "numberInSequence": 3
              },
              {
                "chromosome": "7",
                "startPosition": 55214299,
                "endPosition": 55214433,
                "strand": "+",
                "numberInSequence": 4
              },
              {
                "chromosome": "7",
                "startPosition": 55218987,
                "endPosition": 55219055,
                "strand": "+",
                "numberInSequence": 5
              },
              {
                "chromosome": "7",
                "startPosition": 55220239,
                "endPosition": 55220357,
                "strand": "+",
                "numberInSequence": 6
              },
              {
                "chromosome": "7",
                "startPosition": 55221704,
                "endPosition": 55221845,
                "strand": "+",
                "numberInSequence": 7
              },
              {
                "chromosome": "7",
                "startPosition": 55223523,
                "endPosition": 55223639,
                "strand": "+",
                "numberInSequence": 8
              },
              {
                "chromosome": "7",
                "startPosition": 55224226,
                "endPosition": 55224352,
                "strand": "+",
                "numberInSequence": 9
              },
              {
                "chromosome": "7",
                "startPosition": 55224452,
                "endPosition": 55224536,
                "strand": "+",
                "numberInSequence": 10
              }
            ]
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 1,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/225738/components/CDS"
    }
  ]
}