Retrieve Proteins for a Gene Identifier
get
/ohfapi/cg/v3.3/genes/{id}/proteins
This endpoint supports the retrieval of Proteins for a Gene Row ID passed. It returns Protein information like Protein Identifier, Name, Accession, Ensembl Version, Protein References and other Protein 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
Gene protein(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/proteins
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Proteins", "items": [ { "proteinId": 78371, "proteinName": "EGFR_HUMAN", "accession": "P00533; O00688; O00732; P06268; Q14225; Q68GS5; Q92795; Q9BZS2; Q9GZX1; Q9H2C9; Q9H3C9; Q9UMD7; Q9UMD8; Q9UMG5;", "ensemblVersion": "GRCH37.75", "proteinReferences": [ { "referenceId": "ENSP00000275493", "database": "Ensembl" }, { "referenceId": "X00588", "database": "EMBL" }, { "referenceId": "U95089", "database": "EMBL" }, { "referenceId": "U48722", "database": "EMBL" } "geneReference": { "reference": "/ohfapi/cg/v3.3/genes/50259" } } ], "count": 1, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/proteins" } ] }