REST API for Oracle Healthcare Translational Research

Retrieve Variant References for a Variant Identifier

get

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

This endpoints supports the retrieval of Variant References information for a Variant Identifier. It returns Variant Reference information like Database, Reference Identifier and other Reference 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 : VariantXRefs

Type: object

Properties

resourceType: Type: string
variantIdentifier: Type: object Identifier

Identifier assigned by a given system
variantReferences: Type: object LinkedReference
variantXref: Type: array variantXref

List of Variant XRef Information

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

Type: array

List of Variant XRef Information

Items

Type: object VariantXRef

Nested Schema : VariantXRef

Type: object

Properties

database: Type: string

Database Name. For ex.,dbSNP_142
referenceId: Type: string

Reference ID to External Database. For ex.,rs13079411

400 Response

Invalid parameters supplied

404 Response

Variant varaint XRef(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/variants/536777/variantXRef

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType" : "VariantXRef",
  "variantIdentifier" : {
    "system" : "ODB",
    "value" : "536777"
  },
  "variantXref" : [ {
    "database" : "dbSNP_138",
    "referenceId" : "rs137927599"
  } ],
  "variantReferences" : {
    "reference" : "/HSDataService-web/api/3.2.0/variants/536777"
  }
}