Retrieve Pathways
get
/ohfapi/cg/v3.3/pathways
This endpoint supports the retrieval of Pathways. It returns Pathway information like Pathway Identifier, Name, Source, Pathway Version, Species, Member Count and other Pathway associated information.
Request
Supported Media Types
- application/json
- application/xml
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
pathways(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/pathways
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "Pathways", "items": [ { "identifier": { "system": "ODB", "value": "1" }, "pathwayName": "The role of Nef in HIV-1 replication and disease pathogenesis", "pathwaySource": "REACTOME", "pathwayVersion": "GRCH37.75_PATHWAY", "species": "homo sapiens", "memberCount": 17, "pathwayMember": { "reference": "/ohfapi/cg/v3.3/pathways/1" } }], "count": 1, "hasMore": true, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/pathways" } ] }