REST API for Oracle Healthcare Translational Research

Retrieve Gene Components for a Gene Identifier

get

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

This endpoint supports the retrieval of Gene Components for a Gene Row ID passed. It returns Gene Components like Gene Name, Ensembl Version, Transcript ID and a set of Component Types CDS, xon, mRNA, STS, misc_RNA, misc_feature and intron.

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 : 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 all 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/components

Example of Response Body

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

{
  "resourceType": "GeneComponents",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "225771"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000485503",
        "componentType": [
          {
            "misc_RNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225771/components/misc_RNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225771/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225759"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000459688",
        "componentType": [
          {
            "misc_RNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225759/components/misc_RNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225759/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225738"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225738/components/CDS"
            }
          },
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225738/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225738/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225762"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225762/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225762/components/intron"
            }
          },
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225762/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225738"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000420316",
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225738/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225738/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225735"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225735/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225735/components/intron"
            }
          },
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225735/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225732"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225732/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225732/components/intron"
            }
          },
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225732/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225761"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000463948",
        "componentType": [
          {
            "misc_RNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225761/components/misc_RNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225761/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225753"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225753/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225753/components/intron"
            }
          },
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225753/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225762"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000450046",
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225762/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225743"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225743/components/CDS"
            }
          },
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225743/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225743/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225733"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225733/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225733/components/intron"
            }
          },
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225733/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225765"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225765/components/CDS"
            }
          },
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225765/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225765/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225753"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000442591",
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225753/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225743"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000275493",
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225743/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225743/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225765"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000454757",
        "componentType": [
          {
            "mRNA": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225765/components/mRNA"
            },
            "intron": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225765/components/intron"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225733"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000342916",
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225733/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225728"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "exon": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225728/components/exon"
            }
          },
          {
            "sts": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225728/components/STS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225735"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000344576",
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225735/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225732"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "transcriptId": "ENST00000455089",
        "componentType": [
          {
            "cds": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225732/components/CDS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "225728"
      },
      "geneName": "ENSG00000146648",
      "ensemblVersion": "GRCH37.75",
      "componentSource": {
        "componentType": [
          {
            "sts": {
              "reference": "/HSDataService-web/api/3.2.0/genes/50259/225728/components/STS"
            }
          }
        ]
      },
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 21,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/components"
    }
  ]
}