Retrieve Gene References for a Gene Identifier
get
/ohfapi/cg/v3.3/genes/{id}/geneXref
This endpoint supports the retrieval of Gene References for a Gene Row ID passed. It returns Gene Reference information like Reference Identifier, Database, DNA Reference Version and other Gene Reference associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
gene row ID
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 parameters supplied
404 Response
GeneXRef data not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/geneXref
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "GeneXRef", "items": [ { "identifier": { "system": "ODB", "value": "29966" }, "referenceId": "ENSG00000146648", "database": "EMBL", "dnaReferenceVersion": "GRCH37.75", "geneRef": { "reference": "/ohfapi/cg/v3.3/genes/50259" } }, { "identifier": { "system": "ODB", "value": "239940" }, "referenceId": "EGFR", "database": "locus_tag", "dnaReferenceVersion": "GRCH37.75", "geneRef": { "reference": "/ohfapi/cg/v3.3/genes/50259" } } ], "count": 2, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/geneXref" } ] }