REST API for Oracle Healthcare Translational Research

Retrieve Cancers for a Gene Identifier

get

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

This endpoint supports the retrieval of Cancers for a Gene Row ID passed. It returns Cancer information like Primary Histology, Histology Subtype, Hugoname, Curation Source and other Cancer 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 : PageableCollectionCosmic

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 Cosmic

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

Type: object

Properties

curationSource: Type: string

Curation Source Name
geneReference: Type: string

A link containing href to retrieve Gene details

Example: /genes/{geneId}
histologySubtype: Type: string

Histology Subtype Name
hugoName: Type: string

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

Anatomical Primary Site Name
primarySite: Type: string

Anatomical Subtype
siteSubType: Type: string

Site Subtype
version: Type: string

Version Label. For ex.,SIFT_VER2_75

400 Response

Invalid parameters supplied

404 Response

cancer data not found

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "CancerGenes",
  "items": [
    {
      "primaryHistology": "NS",
      "histologySubtype": "NS",
      "primarySite": "large_intestine",
      "siteSubType": "colon",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "adrenal_cortical_carcinoma",
      "histologySubtype": "NS",
      "primarySite": "adrenal_gland",
      "siteSubType": "adrenal_gland",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "NS",
      "primarySite": "NS",
      "siteSubType": "NS",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "small_cell_carcinoma",
      "primarySite": "lung",
      "siteSubType": "right_upper_lobe",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "squamous_cell_carcinoma",
      "primarySite": "eye",
      "siteSubType": "conjunctiva",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "squamous_cell_carcinoma",
      "primarySite": "lung",
      "siteSubType": "NS",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "squamous_cell_carcinoma",
      "primarySite": "lung",
      "siteSubType": "NS",
      "hugoName": "EGFR_ENST00000344576",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "squamous_cell_carcinoma",
      "primarySite": "lung",
      "siteSubType": "right_lower_lobe",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    },
    {
      "primaryHistology": "carcinoma",
      "histologySubtype": "squamous_cell_carcinoma",
      "primarySite": "oesophagus",
      "siteSubType": "NS",
      "hugoName": "EGFR",
      "curationSource": "COSMIC",
      "version": "COSMIC.V67",
      "geneReference": {
        "reference": "/HSDataService-web/api/3.2.0/genes/50259"
      }
    }
  ],
  "count": 100,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/cancer"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genes/50259/cancer?offset=100"
    }
  ]
}