Retrieve Genome Assembly Reference Versions for an Assembly Name
get
/ohfapi/cg/v3.3/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: string
Assembly/Alignment Name
Query Parameters
-
limit(optional): integer(int32)
Number of rows to return
-
offset(optional): integer(int32)
Row number to start from
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
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
Nested Schema : links
Type:
array
A collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}
Nested Schema : Serializable
Type:
object
400 Response
Invalid parameter supplied
404 Response
genomeAssembly ensemblVersions not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/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:7010/ohfapi/cg/v3.3/genomeAssemblyRefVersions/byName/grch37" } ] }