Jump to

• Request
• Response
• Examples

Retrieve Variants for Gene Identifiers and Gene Components

get

/ohfapi/cg/v3.3/variants/byGeneComponents

This endpoint supports the retrieval of Variant Identifiers for multiple Gene Identifiers, multiple Gene Components, Assembly/Alignment Identifier, Flanking Offset and Promoter Offset. The response fetches Variant ID(s) filtered based on given input.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• alignmentId: integer(int64)
  Minimum Value: 0

  Assembly/Alignment ID
• flankingOffset(optional): integer(int64)
  Flanking Offset. For ex.,100
• geneComponent: array
  Collection Format: multi

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Gene Component. For ex.,mRNA

  • [0]: string

  {
      "name":"geneComponent",
      "in":"query",
      "description":"Gene Component. For ex.,mRNA",
      "required":true,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "maxItems":2147483647,
      "minItems":1
  }

• geneWid: array
  Collection Format: multi

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of Gene IDs

  • [0]: integer(int64)

  {
      "name":"geneWid",
      "in":"query",
      "description":"List of Gene IDs",
      "required":true,
      "type":"array",
      "items":{
          "type":"integer",
          "format":"int64"
      },
      "collectionFormat":"multi",
      "maxItems":2147483647,
      "minItems":1
  }

• limit(optional): integer(int32)
  Number of rows to return
• offset(optional): integer(int32)
  Row number to start from
• promoterOffset(optional): integer(int64)
  Promoter Offset. For ex.,100

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

GeneComponent is not supplied

404 Response

Variants not found for the Gene Wids and geneComponents supplied

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/variants/byGeneComponents?geneComponent=geneRegion&geneComponents=CDS&geneWid=50259&alignmentId=1&limit=20&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "Variants",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "26858484"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "26858485"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "26858486"
      }
    },{
      "identifier": {
        "system": "ODB",
        "value": "26858503"
      }
    }
  ],
  "count": 20,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/variants/byGeneComponents?geneComponent=geneRegion&geneComponents=CDS&geneWid=50259&alignmentId=1&limit=20&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/variants/byGeneComponents?alignmentId=1&offset=20&geneComponent=geneRegion&geneWid=50259&geneComponents=CDS&limit=20"
    }
  ]
}

Back to Top