Retrieve HUGO Names for a Pathway Identifier
get
/ohfapi/cg/v3.3/pathways/{id}
This endpoint supports the retrieval of HUGO Names by Pathway Identifier.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Gene_set_id value of a geneSet
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
Model for paginated collections of data.
Root Schema : PageableCollectionPathwayMember
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 : PathwayMember
Type:
Show Source
object
-
hugoName(optional):
string
Approved HUGO symbol for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.
400 Response
Invalid parameters supplied
404 Response
pathway member(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/pathways/102
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Pathway", "items": [ { "hugoName": "CLP1" }, { "hugoName": "CPSF1" }, { "hugoName": "CPSF2" }, { "hugoName": "CPSF3" }], "count": 4, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/pathways/102" } ] }