REST API for Oracle Healthcare Translational Research

Retrieve HUGO Names for a Pathway Identifier

get

/HSDataService-web/api/3.2.0/pathways/{id}

This endpoint supports the retrieval of HUGO Names by Pathway Identifier.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Gene_set_id value of a geneSet

Query Parameters

limit: Type: integer (int32)

Number of rows to return
offset: Type: integer (int32)

Row number to start from

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollection

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object Serializable

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

pathway member(s) not found

Examples

The following example submits a GET request.

API URL

 http://localhost:7001/HSDataService-web/api/3.2.0/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:7001/HSDataService-web/api/3.2.0/pathways/102"
    }
  ]
}