Jump to

• Request
• Response
• Examples

Retrieve Genes for a Geneset Identifier

get

/ohfapi/cg/v3.3/geneSets/{id}

This endpoint supports the retrieval of Genes by Geneset Row ID.

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollectionGeneSetMembers

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

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/GeneSetMembers"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object GeneSetMembers

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/GeneSetMembers"
    }
}

Nested Schema : links

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

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

Nested Schema : GeneSetMembers

Type: object

Show Source

• geneName(optional): string
  Gene Name. For ex.,RN5S300
• hugoName(optional): string
  Approved HUGO symbol for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.
• species(optional): string
  Scientific Species Name

{
    "type":"object",
    "properties":{
        "geneName":{
            "type":"string",
            "description":"Gene Name. For ex.,RN5S300"
        },
        "hugoName":{
            "type":"string",
            "description":"Approved HUGO symbol for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc. "
        },
        "species":{
            "type":"string",
            "description":"Scientific Species Name"
        }
    }
}

400 Response

Invalid parameters supplied

404 Response

genes not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/geneSets/7

Example of Response Body

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

{
  "resourceType": "GeneSet",
  "items": [
    {
      "hugoName": "CICP27"
    },
    {
      "hugoName": "DDX11L1"
    },
    {
      "hugoName": "FAM138A"
    },
    {
      "hugoName": "MIR1302-10"
    },
    {
      "hugoName": "OR4F5"
    },
    {
      "hugoName": "OR4G11P"
    },
    {
      "hugoName": "OR4G4P"
    },
    {
      "hugoName": "RP11-34P13.7"
    },
    {
      "hugoName": "RP11-34P13.8"
    },
    {
      "hugoName": "WASH7P"
    }
  ],
  "count": 10,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http:localhost:7010/ohfapi/cg/v3.3/geneSets/7"
    }
  ]
}

Back to Top