Jump to

• Request
• Response
• Examples

Retrieve Variant References for a Variant Identifier

get

/ohfapi/cg/v3.3/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: integer(int64)
  Variant Row ID

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : VariantXRefs

Type: object

Show Source

• resourceType(optional): string
• variantIdentifier(optional): object Identifier
  Identifier assigned by a given system
• variantReferences(optional): object LinkedReference
• variantXref(optional): array variantXref
  List of Variant XRef Information

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "variantIdentifier":{
            "description":"Variant Row ID",
            "$ref":"#/definitions/Identifier"
        },
        "variantXref":{
            "type":"array",
            "description":"List of Variant XRef Information",
            "items":{
                "$ref":"#/definitions/VariantXRef"
            }
        },
        "variantReferences":{
            "example":"{href: '/variants/{variantRecordId}'}",
            "description":"A link containing href to retrieve Variant Annotation details",
            "$ref":"#/definitions/LinkedReference"
        }
    }
}

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Show Source

• system(optional): string
  System which assigned this identifier
• value(optional): string
  Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : variantXref

Type: array

List of Variant XRef Information

Show Source

• Array of: object VariantXRef

{
    "type":"array",
    "description":"List of Variant XRef Information",
    "items":{
        "$ref":"#/definitions/VariantXRef"
    }
}

Nested Schema : VariantXRef

Type: object

Show Source

• database(optional): string
  Database Name. For ex.,dbSNP_142
• referenceId(optional): string
  Reference ID to External Database. For ex.,rs13079411

{
    "type":"object",
    "properties":{
        "database":{
            "type":"string",
            "description":"Database Name. For ex.,dbSNP_142"
        },
        "referenceId":{
            "type":"string",
            "description":"Reference ID to External Database. For ex.,rs13079411"
        }
    }
}

400 Response

Invalid parameters supplied

404 Response

Variant varaint XRef(s) not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/variants/536777"
  }
}

Back to Top