REST API for Oracle Healthcare Translational Research

Retrieve Genome Assembly Reference Versions for Assembly Names

get

/HSDataService-web/api/3.2.0/genomeAssemblyRefVersions/byName

This endpoint supports the retrieval of Genomic Assembly Reference Versions for multiple Assembly/Alignment Names. It returns Genomic Assembly Reference Version information like Version Identifiers, Version Name and other associated information.

Request

Supported Media Types

application/json
application/xml

Query Parameters

limit

Type: integer (int32)

Number of rows to return

name

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 0

Maximum Number of Items: 2147483647

List of Assembly/Alignment Names

Items

Type: string

offset

Type: integer (int32)

Row number to start from

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

Invalid parameters supplied

404 Response

genomeAssembly ensemblVersions not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/genomeAssemblyRefVersions/byName?name=grch37&name=grch38

Example of Response Body

The following example shows the response returned in JSON format.

{
  "resourceType": "EnsemblVersions",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "2"
      },
      "ensemblVersion": "GRCH37.75"
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "21"
      },
      "ensemblVersion": "GRCH37.70"
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/genomeAssemblyRefVersions/byName?name=grch37&name=grch38"
    }
  ],
  "invalidAssemblies": [
    "grch38"
  ]
}