REST API for Oracle Healthcare Translational Research

Retrieve Genesets

get

/HSDataService-web/api/3.2.0/geneSets

This endpoint supports the retrieval of Genesets by User Name. It returns Geneset information like Gene Set Identifier, Name, Description, Gene Count and other Geneset associated information.

Request

Supported Media Types

application/json
application/xml

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

geneSet(s) not found

Examples

The following example submits a GET request.

API URL

http:localhost:7001/HSDataService-web/api/3.2.0/geneSets?limit=10&offset=0

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "GeneSets",
  "items": [
    {
      "geneSetId": 7,
      "geneSetName": "GENE_SET7",
      "geneSetDesc": "GENE_SET_DESC7",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/7"
      }
    },
    {
      "geneSetId": 8,
      "geneSetName": "GENE_SET8",
      "geneSetDesc": "GENE_SET_DESC8",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/8"
      }
    },
    {
      "geneSetId": 9,
      "geneSetName": "GENE_SET9",
      "geneSetDesc": "GENE_SET_DESC9",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/9"
      }
    },
    {
      "geneSetId": 10,
      "geneSetName": "GENE_SET10",
      "geneSetDesc": "GENE_SET_DESC10",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/10"
      }
    },
    {
      "geneSetId": 11,
      "geneSetName": "GENE_SET11",
      "geneSetDesc": "GENE_SET_DESC11",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/11"
      }
    },
    {
      "geneSetId": 12,
      "geneSetName": "GENE_SET12",
      "geneSetDesc": "GENE_SET_DESC12",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/12"
      }
    },
    {
      "geneSetId": 13,
      "geneSetName": "GENE_SET13",
      "geneSetDesc": "GENE_SET_DESC13",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/13"
      }
    },
    {
      "geneSetId": 14,
      "geneSetName": "GENE_SET14",
      "geneSetDesc": "GENE_SET_DESC14",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/14"
      }
    },
    {
      "geneSetId": 15,
      "geneSetName": "GENE_SET15",
      "geneSetDesc": "GENE_SET_DESC15",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/15"
      }
    },
    {
      "geneSetId": 16,
      "geneSetName": "GENE_SET16",
      "geneSetDesc": "GENE_SET_DESC16",
      "geneCount": 10,
      "geneSetMember": {
        "reference": "/HSDataService-web/api/3.2.0/geneSets/16"
      }
    }
  ],
  "count": 10,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/geneSets?limit=10&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/geneSets?offset=10&limit=10"
    }
  ]
}