REST API for Oracle Healthcare Translational Research

Retrieve Variants for Reference Identifiers and Database with POST Request

post

/HSDataService-web/api/3.2.0/variants/byReferenceId

This endpoint supports the retrieval of Variant Identifiers for multiple Reference Identifiers, multiple Database and single Assembly/Alignment ID.It also returns if any Invalid Reference Identifiers are passed in the Request.

Request

Supported Media Types

application/json
application/xml

Query Parameters

limit: Type: integer (int32)

Number of rows to return
offset: Type: integer (int32)

Row number to start from

Body Parameter

Root Schema : VariantReferenceIdDatabaseDef

Type: object

Properties

alignmentId: Type: integer (int64)

Required: true

Minimum Value: 0

Assembly/Alignment ID
databases: Type: array databases

List of Database Names. For ex.,dbSNP_142
referenceIds: Type: array referenceIds

Required: true

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of Reference IDs to External Database. For ex.,rs13079411

Nested Schema : databases

Type: array

List of Database Names. For ex.,dbSNP_142

Items

Type: string

Nested Schema : referenceIds

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of Reference IDs to External Database. For ex.,rs13079411

Items

Type: string

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableDetailedCollection

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.
invalidAssemblies: Type: array invalidAssemblies

List of Invalid Assemblies in request.
invalidGeneNames: Type: array invalidGeneNames

List of Invalid Genenames in request.
invalidHugoNames: Type: array invalidHugoNames

List of Invalid Hugonames in request.
invalidReferenceIds: Type: array invalidReferenceIds

List of Invalid Reference IDs in request.
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 : invalidAssemblies

Type: array

List of Invalid Assemblies in request.

Items

Type: string

Nested Schema : invalidGeneNames

Type: array

List of Invalid Genenames in request.

Items

Type: string

Nested Schema : invalidHugoNames

Type: array

List of Invalid Hugonames in request.

Items

Type: string

Nested Schema : invalidReferenceIds

Type: array

List of Invalid Reference IDs in request.

Items

Type: string

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object Serializable

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

Type: object

400 Response

Assembly/Alignment Id is not supplied

404 Response

Variants not found for the Reference Ids and Reference Databases supplied

Examples

The following example submits a POST request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/variants/byReferenceId?limit=2&offset=0

Example of Request Body

The following example shows the response returned in JSON format.

{
    "alignmentId": 1,
    "referenceIds": [
        "rs142950474",
        "rs142950477",
        "COSM297314",
        "COSM",
        "rs"
    ],
    "databases": [
        "dbSNP_138",
        "COSMIC_COSMIC.V67"
    ]
}

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType" : "Variants",
  "items" : [ {
    "identifier" : {
      "system" : "ODB",
      "value" : "4754980"
    }
  }, {
    "identifier" : {
      "system" : "ODB",
      "value" : "38063682"
    }
  } ],
  "count" : 2,
  "hasMore" : true,
  "links" : [ {
    "rel" : "self",
    "href" : "http://localhost:7001/HSDataService-web/api/3.2.0/variants/byReferenceId?limit=2&offset=0"
  }, {
    "rel" : "next",
    "href" : "http://localhost:7001/HSDataService-web/api/3.2.0/variants/byReferenceId?offset=2&limit=2"
  } ],
  "invalidReferenceIds" : [ "COSM", "rs" ]
}