Retrieve Genomic Positions for a Gene Identifier
get
/ohfapi/cg/v3.3/genes/{id}/genomicPositions
This endpoint supports the retrieval of Genomic Positions for a single Gene Row ID passed. It returns Genomic Position information like Genomic Position, HUGO Name, Ensembl Name and other Genomic Position associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
gene row ID
Query Parameters
-
limit(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
-
offset(optional): integer(int32)
Pagination query params: ?limit=2&offset=0
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Model for paginated collections of data.
Root Schema : PageableCollectionGenePosition
Type:
object
Model for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
Default Value:
false
A boolean indicating if more pages are available. -
items(optional):
array items
A collection of paged items.
-
links(optional):
array link
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : link
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 : GenePosition
Type:
Show Source
object
-
assembly(optional):
string
Assembly/Alignment Name. For ex.,GRCh38
-
geneReference(optional):
object LinkedReference
-
genomicPosition(optional):
object GenomicPosition
-
hugoName(optional):
string
Approved HUGO symbol for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.
-
identifier(optional):
object OdbIdentifier
Identifier assigned by a given system
Nested Schema : GenomicPosition
Type:
Show Source
object
-
chromosome(optional):
string
Chromosome Name. For ex.,'Y'
-
chromosomeId(optional):
string
-
chromosomeName(optional):
string
Chromosome Name. For ex.,'Y'
-
dateOfLoading(optional):
string(date-time)
Insert Date
-
dnaReferenceVersion(optional):
string
Version Label. For ex.,SIFT_VER2_75
-
endPosition(optional):
integer(int64)
End location of sequence
-
ensemblReleaseDate(optional):
string(date-time)
Date that this sequence source is released to be used to add versions of the same data
-
numberInSequence(optional):
integer(int64)
Ordering of each Segment of the Component
-
position(optional):
integer(int64)
-
startPosition(optional):
integer(int64)
Start location of sequence
-
strand(optional):
string
Strand Value
Nested Schema : OdbIdentifier
Type:
object
Identifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
400 Response
Invalid parameters supplied
404 Response
Genomic position(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/genomicPositions
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "GenomicPositions", "items": [ { "identifier": { "system": "ODB", "value": "51649" }, "genomicPosition": { "chromosome": "7", "startPosition": 55086714, "endPosition": 55324313, "strand": "+", "dnaReferenceVersion": "GRCH37.75" }, "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259", "display": "EGFR" }, "hugoName": "EGFR", "assembly": "GRCh37" } ], "count": 1, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/genomicPositions" } ] }