Retrieve Cancers for a Gene Identifier
get
/ohfapi/cg/v3.3/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: integer(int64)
Minimum Value:
0
gene row ID
Query Parameters
-
limit(optional): integer(int32)
Number of rows to return
-
offset(optional): integer(int32)
Row number to start from
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : PageableCollection
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
A boolean indicating if more pages are available.
-
items(optional):
array items
A collection of paged items.
-
links(optional):
array links
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : Serializable
Type:
object
400 Response
Invalid parameters supplied
404 Response
cancer data not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "adrenal_cortical_carcinoma", "histologySubtype": "NS", "primarySite": "adrenal_gland", "siteSubType": "adrenal_gland", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "NS", "primarySite": "NS", "siteSubType": "NS", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "small_cell_carcinoma", "primarySite": "lung", "siteSubType": "right_upper_lobe", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "squamous_cell_carcinoma", "primarySite": "eye", "siteSubType": "conjunctiva", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "squamous_cell_carcinoma", "primarySite": "lung", "siteSubType": "NS", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "squamous_cell_carcinoma", "primarySite": "lung", "siteSubType": "NS", "hugoName": "EGFR_ENST00000344576", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "squamous_cell_carcinoma", "primarySite": "lung", "siteSubType": "right_lower_lobe", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "primaryHistology": "carcinoma", "histologySubtype": "squamous_cell_carcinoma", "primarySite": "oesophagus", "siteSubType": "NS", "hugoName": "EGFR", "curationSource": "COSMIC", "version": "COSMIC.V67", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } } ], "count": 100, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/cancer" }, { "rel": "next", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/cancer?offset=100" } ] }