Create Geneset
post
/ohfapi/cg/v3.3/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
Inputs for creating a geneset
Root Schema : GeneSetInputs
Type:
object
Inputs for creating a geneset
Show Source
-
assemblyVersions(optional):
array assemblyVersions
list of assembly versions
-
geneNames(optional):
array geneNames
List of gene names
-
geneSetDesc(optional):
string
geneSet description
-
geneSetName(optional):
string
geneSet name
-
hugoNames(optional):
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(optional):
string
species name
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.
Show Source
Security
-
basicAuth: basic
Type:
basic
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Root Schema : GeneSet
Type:
Show Source
object
-
geneCount(optional):
object Number
-
geneSetDesc(optional):
string
Gene Set Description. For ex.,RN5S300
-
geneSetId(optional):
object Number
-
geneSetMember(optional):
object LinkedReference
-
geneSetName(optional):
string
Gene Set Name. For ex.,RN5S300
-
invalidGeneNames(optional):
array invalidGeneNames
List of invalid Gene Names provided in the request
-
invalidHugoNames(optional):
array invalidHugoNames
List of invalid HUGO Names provided in the request
Nested Schema : Number
Type:
object
Nested Schema : invalidGeneNames
Type:
array
List of invalid Gene Names provided in the request
Show Source
Nested Schema : invalidHugoNames
Type:
array
List of invalid HUGO Names provided in the request
Show Source
400 Response
Invalid parameters supplied
404 Response
geneSet not created
Examples
The following example submits a POST request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/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": "/ohfapi/cg/v3.3/geneSets/10000000002249" } }