REST API for Oracle Healthcare Translational Research

Create Geneset

post

/HSDataService-web/api/3.2.0/geneSets/create

This endpoint supports the creation of a Geneset for the Logging in User with Geneset Name, multiple Hugo Names or Gene Names, Species, Assembly Versions, Description as inputs. It returns Geneset information like Geneset identifier, Name, Description and Gene Count.

Request

Supported Media Types

application/json
application/xml

Body Parameter

Inputs for creating a geneset

Root Schema : GeneSetCreateRequest

Type: object

Inputs for creating a geneset

Properties

assemblyVersions: Type: array assemblyVersions

list of assembly versions
geneNames: Type: array geneNames

List of gene names
geneSetDesc: Type: string

geneSet description
geneSetName: Type: string

geneSet name
hugoNames: Type: array hugoNames

List of the approved HUGO symbols for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.
species: Type: string

species name

Nested Schema : assemblyVersions

Type: array

list of assembly versions

Items

Type: string

Nested Schema : geneNames

Type: array

List of gene names

Items

Type: string

Nested Schema : hugoNames

Type: array

List of the approved HUGO symbols for species loci, including protein coding genes, RNA genes and pseudogenes, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.

Items

Type: string

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Root Schema : GeneSet

Type: object

Properties

geneCount: Type: object Number
geneSetDesc: Type: string

Gene Set Description. For ex.,RN5S300
geneSetId: Type: object Number
geneSetMember: Type: object LinkedReference
geneSetName: Type: string

Gene Set Name. For ex.,RN5S300
invalidGeneNames: Type: array invalidGeneNames

List of invalid Gene Names provided in the request
invalidHugoNames: Type: array invalidHugoNames

List of invalid HUGO Names provided in the request

Nested Schema : Number

Type: object

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : invalidGeneNames

Type: array

List of invalid Gene Names provided in the request

Items

Type: string

Nested Schema : invalidHugoNames

Type: array

List of invalid HUGO Names provided in the request

Items

Type: string

400 Response

Invalid parameters supplied

404 Response

geneSet not created

Examples

The following example submits a POST request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/geneSets/create

Example of Request Body

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

{
  "hugoNames": ["BID","EGFR"],
   "geneNames":["ENSG00000015475"],
   "species" : "homo sapiens",
   "assemblyVersions":["GRCh37"],
   "geneSetName":"geneSet",
   "geneSetDesc":"geneSetDesc"
     
}

Example of Response Body

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

{
  "geneSetId": 10000000002249,
  "geneSetName": "geneSet",
  "geneSetDesc": "geneSetDesc",
  "geneCount": 2,
  "geneSetMember": {
    "reference": "/HSDataService-web/api/3.2.0/geneSets/10000000002249"
  }
}