REST API for Oracle Healthcare Translational Research

Retrieve Genome Assembly Reference Versions for an Assembly Name

get

/HSDataService-web/api/3.2.0/genomeAssemblyRefVersions/byName/{name}

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

Request

Supported Media Types

application/json
application/xml

Path Parameters

name: Type: string

Required: true

Assembly/Alignment Name

Query Parameters

limit: Type: integer (int32)

Number of rows to return
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 : PageableCollectionDNARefVersion

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 DNARefVersion

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

Type: object

Properties

chromosome: Type: array chromosome

List of Chromosome Genomic Positions
ensemblVersion: Type: string

Ensembl Version. For ex.,GRCH37.75
identifier: Type: object Identifier

Identifier assigned by a given system
isPreferred: Type: string
versionWID: Type: integer (int64)

Nested Schema : chromosome

Type: array

List of Chromosome Genomic Positions

Items

Type: object GenomicPosition

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

Type: object

Properties

chromosome: Type: string

Chromosome Name. For ex.,'Y'
chromosomeId: Type: string
chromosomeName: Type: string

Chromosome Name. For ex.,'Y'
dateOfLoading: Type: string (date-time)

Insert Date
dnaReferenceVersion: Type: string

Version Label. For ex.,SIFT_VER2_75
endPosition: Type: integer (int64)

End location of sequence
ensemblReleaseDate: Type: string (date-time)

Date that this sequence source is released to be used to add versions of the same data
numberInSequence: Type: integer (int64)

Ordering of each Segment of the Component
position: Type: integer (int64)
startPosition: Type: integer (int64)

Start location of sequence
strand: Type: string

Strand Value

400 Response

Invalid parameter 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/grch37

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/grch37"
    }
  ]
}