Retrieve Genes for Gene Names
get
/ohfapi/cg/v3.3/genes/byGeneName
This endpoint supports the retrieval of Genes for multiple Gene Names and Assembly/Alignment Row ID passed. It returns Gene information like Gene Name, HUGO Name, Assembly/Alignment, Chromosome and other Gene related information.It also returns if any Invalid Gene Names are passed in the Request.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
alignmentId: integer(int64)
Minimum Value:
0
Alignment row ID -
limit(optional): integer(int32)
Number of rows to return
-
name: array
Collection Format:
multi
Minimum Number of Items:1
Maximum Number of Items:2147483647
Gene name -
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 : PageableDetailedCollection
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.
-
invalidAssemblies(optional):
array invalidAssemblies
List of Invalid Assemblies in request.
-
invalidGeneNames(optional):
array invalidGeneNames
List of Invalid Genenames in request.
-
invalidHugoNames(optional):
array invalidHugoNames
List of Invalid Hugonames in request.
-
invalidReferenceIds(optional):
array invalidReferenceIds
List of Invalid Reference IDs in request.
-
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 : invalidReferenceIds
Type:
array
List of Invalid Reference IDs in request.
Show Source
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
Genes(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/byGeneName?name=ENSG00000015475&name=ENSG00000146648&alignmentId=1
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Genes", "items": [ { "identifier": { "system": "ODB", "value": "22797" }, "geneName": "ENSG00000015475", "hugoName": "BID", "assembly": "GRCh37", "chromosome": "22", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/22797" } }, { "identifier": { "system": "ODB", "value": "50259" }, "geneName": "ENSG00000146648", "hugoName": "EGFR", "assembly": "GRCh37", "chromosome": "7", "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } } ], "count": 2, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/byGeneName?name=ENSG00000015475&name=ENSG00000146648&alignmentId=1" } ] }