REST API for Oracle Healthcare Translational Research

Retrieve Variant Cancers for a Variant Identifier

get

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

This endpoint supports the retrieval of Variant Cancers for a Variant Identifier. It retuns Variant Cancer information like HUGO Name, Transcript Identifier, Assembly/Alignment Name, Ensembl Version, Amino Acid Change and other Variant Cancer associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Variant Row ID

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : VariantCancers

Type: object

Properties

cancerVariant: Type: array cancerVariant

List of Variant Cancers
identifier: Type: object Identifier

Identifier assigned by a given system
resourceType: Type: string
variantReferences: Type: object LinkedReference

Nested Schema : cancerVariant

Type: array

List of Variant Cancers

Items

Type: object VariantCancer

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

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : VariantCancer

Type: object

Properties

accession: Type: string

Accession Name
anatomicalSubtype: Type: string

Anatomical Subtype
assembly: Type: string

Assembly/Alignment Name. For ex.,GRCh38
coding: Type: string

Mutation in Coding Sequence Flag
curationSource: Type: string

Curation Source Name
gwScreen: Type: string

Sample Genome Wide Screen Flag
hgncId: Type: string

HUGO Gene Nomenclature Reference ID
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.
mutationSomaticStatus: Type: string

Somatic Mutation Status
primaryHistology: Type: string

Anatomical Primary Site Name
referenceID: Type: string

Cosmic Mutation ID
siteSubType: Type: string

Site Subtype
version: Type: string

Version Label. For ex.,SIFT_VER2_75
zygosity: Type: string

Zygosity of Mutation

400 Response

Variant Id is not supplied

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/variants/7678/cancer

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType" : "CancerVariants",
  "identifier" : {
    "system" : "ODB",
    "value" : "7678"
  },
  "cancerVariant" : [ {
    "primaryHistology" : "carcinoma",
    "histologySubtype" : "adenocarcinoma",
    "siteSubType" : "large_intestine",
    "anatomicalSubtype" : "colon",
    "hugoName" : "SAMD11",
    "accession" : "ENST00000342066",
    "hgncId" : "28706",
    "mutationSomaticStatus" : "Variant of unknown origin",
    "referenceID" : "COSM1344644",
    "zygosity" : "het",
    "gwScreen" : "y",
    "coding" : "Y",
    "curationSource" : "COSMIC",
    "version" : "COSMIC.V67",
    "assembly" : "GRCh37"
  }, {
    "primaryHistology" : "carcinoma",
    "histologySubtype" : "NS",
    "siteSubType" : "liver",
    "anatomicalSubtype" : "NS",
    "hugoName" : "SAMD11",
    "accession" : "ENST00000342066",
    "hgncId" : "28706",
    "mutationSomaticStatus" : "Variant of unknown origin",
    "referenceID" : "COSM1344644",
    "zygosity" : "het",
    "gwScreen" : "y",
    "coding" : "Y",
    "curationSource" : "COSMIC",
    "version" : "COSMIC.V67",
    "assembly" : "GRCh37"
  } ],
  "variantReferences" : {
    "reference" : "/HSDataService-web/api/3.2.0/variants/7678"
  }
}