Jump to

• Request
• Response
• Examples

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

Body ()

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

{
    "type":"object",
    "properties":{
        "hugoNames":{
            "type":"array",
            "description":"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"
            }
        },
        "geneNames":{
            "type":"array",
            "description":"List of gene names",
            "items":{
                "type":"string"
            }
        },
        "species":{
            "type":"string",
            "description":"species name"
        },
        "assemblyVersions":{
            "type":"array",
            "description":"list of assembly versions",
            "items":{
                "type":"string"
            }
        },
        "geneSetName":{
            "type":"string",
            "description":"geneSet name"
        },
        "geneSetDesc":{
            "type":"string",
            "description":"geneSet description"
        }
    },
    "xml":{
        "name":"GeneSetInputs"
    },
    "description":"Inputs for creating a geneset"
}

Nested Schema : assemblyVersions

Type: array

list of assembly versions

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of assembly versions",
    "items":{
        "type":"string"
    }
}

Nested Schema : geneNames

Type: array

List of gene names

Show Source

• Array of: string

{
    "type":"array",
    "description":"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.

Show Source

• Array of: string

{
    "type":"array",
    "description":"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"
    }
}

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : GeneSet

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "geneSetId":{
            "description":"Gene Set Identifier",
            "$ref":"#/definitions/Number"
        },
        "geneSetName":{
            "type":"string",
            "description":"Gene Set Name. For ex.,RN5S300"
        },
        "geneSetDesc":{
            "type":"string",
            "description":"Gene Set Description. For ex.,RN5S300"
        },
        "geneCount":{
            "description":"Total Number of Genes in Gene Set",
            "$ref":"#/definitions/Number"
        },
        "geneSetMember":{
            "example":"{href: 'geneSets/{geneSetId}'}",
            "description":"A link containing href to retrieve Geneset details",
            "$ref":"#/definitions/LinkedReference"
        },
        "invalidHugoNames":{
            "type":"array",
            "description":"List of invalid HUGO Names provided in the request",
            "items":{
                "type":"string"
            }
        },
        "invalidGeneNames":{
            "type":"array",
            "description":"List of invalid Gene Names provided in the request",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : Number

Type: object

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : invalidGeneNames

Type: array

List of invalid Gene Names provided in the request

Show Source

• Array of: string

{
    "type":"array",
    "description":"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

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of invalid HUGO Names provided in the request",
    "items":{
        "type":"string"
    }
}

400 Response

Invalid parameters supplied

404 Response

geneSet not created

Back to Top

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"
  }
}

Back to Top