Jump to

• Request
• Response
• Examples

Retrieve Diseases for a Variant Identifier

get

/ohfapi/cg/v3.3/variants/{id}/diseases

This endpoint supports the retrieval of Disease for a Variant Identifier. It returns Disease information like Disease Name, Mutation Type, Variant Type, Feature, Confidence, Curation Source, Ensembl Version, Assembly/Alignment Name and other Disease associated information.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Variant 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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

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

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Serializable"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Serializable

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Serializable"
    }
}

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Nested Schema : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Variant disease(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/diseases

Example of Request Body

The following example shows the response returned in JSON format.

{
  "resourceType" : "DiseasesVariants",
  "items" : [ {
    "diseaseName" : "Zellweger syndrome",
    "mutationType" : "M",
    "variantType" : "DM",
    "feature" : "Zellweger syndrome:233A>G",
    "confidence" : "High",
    "curationSource" : "BIOBASE",
    "ensemblVersion" : "GRCH37.75",
    "assembly" : "GRCh37",
    "variantReferences" : {
      "reference" : "/ohfapi/cg/v3.3/variants/536777"
    }
  } ],
  "count" : 1,
  "hasMore" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "http://localhost:7010/ohfapi/cg/v3.3/variants/536777/diseases"
  } ]
}

Back to Top