REST API for Oracle Healthcare Translational Research

Retrieve Variants for Gene Identifiers and Gene Components

get

/HSDataService-web/api/3.2.0/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

Type: integer (int64)

Required: true

Assembly/Alignment ID

flankingOffset

Type: integer (int64)

Flanking Offset. For ex.,100

geneComponent

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Gene Component. For ex.,mRNA

Items

Type: string

geneWid

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of Gene IDs

Items

Type: integer (int64)

limit

Type: integer (int32)

Number of rows to return

offset

Type: integer (int32)

Row number to start from

promoterOffset

Type: integer (int64)

Promoter Offset. For ex.,100

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionVariant

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

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

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object Variant

Nested Schema : links

Type: array

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

Example

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

Items

Type: string

Nested Schema : Variant

Type: object

Properties

identifier: Type: object Identifier

Identifier assigned by a given system
variantPrediction: Type: object LinkedReference

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

400 Response

GeneComponent is not supplied

404 Response

Variants not found for the Gene Wids and geneComponents supplied

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/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:7001/HSDataService-web/api/3.2.0/variants/byGeneComponents?geneComponent=geneRegion&geneComponents=CDS&geneWid=50259&alignmentId=1&limit=20&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/variants/byGeneComponents?alignmentId=1&offset=20&geneComponent=geneRegion&geneWid=50259&geneComponents=CDS&limit=20"
    }
  ]
}