Jump to

• Request
• Response
• Examples

Retrieve Genes for HUGO Names

get

/ohfapi/cg/v3.3/genes/byHugoName

This endpoint supports the retrieval of Genes for multiple HUGO Names and Assembly/Alignment Row ID passed. It returns Gene information like Gene Name, HUGO Name, Assembly/Alignment, Chromosome and other Gene related information.It also returns if any Invalid HUGO Names are passed in the Request.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• alignmentId: integer(int64)
  Minimum Value: 0

  Alignment row ID
• limit(optional): integer(int32)
  Number of rows to return
• name: array
  Collection Format: multi

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Approved HUGO symbol for species loci, e.g. 'SRY', 'DMRT1', 'FOXL2', etc.

  • [0]: string

  {
      "name":"name",
      "in":"query",
      "description":"Approved HUGO symbol for species loci, e.g. 'SRY', 'DMRT1', 'FOXL2', etc. ",
      "required":true,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"multi",
      "maxItems":2147483647,
      "minItems":1
  }

• 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 : PageableDetailedCollection

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.
• invalidAssemblies(optional): array invalidAssemblies
  List of Invalid Assemblies in request.
• invalidGeneNames(optional): array invalidGeneNames
  List of Invalid Genenames in request.
• invalidHugoNames(optional): array invalidHugoNames
  List of Invalid Hugonames in request.
• invalidReferenceIds(optional): array invalidReferenceIds
  List of Invalid Reference IDs in request.
• 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/Serializable"
            }
        },
        "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"
            }
        },
        "invalidReferenceIds":{
            "type":"array",
            "description":"List of Invalid Reference IDs in request.",
            "items":{
                "type":"string"
            }
        },
        "invalidHugoNames":{
            "type":"array",
            "description":"List of Invalid Hugonames in request.",
            "items":{
                "type":"string"
            }
        },
        "invalidGeneNames":{
            "type":"array",
            "description":"List of Invalid Genenames in request.",
            "items":{
                "type":"string"
            }
        },
        "invalidAssemblies":{
            "type":"array",
            "description":"List of Invalid Assemblies in request.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : invalidAssemblies

Type: array

List of Invalid Assemblies in request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Invalid Assemblies in request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : invalidGeneNames

Type: array

List of Invalid Genenames in request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Invalid Genenames in request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : invalidHugoNames

Type: array

List of Invalid Hugonames in request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Invalid Hugonames in request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : invalidReferenceIds

Type: array

List of Invalid Reference IDs in request.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of Invalid Reference IDs in request.",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Serializable

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

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 : Serializable

Type: object

400 Response

Invalid parameters supplied

404 Response

Genes(s) not found

Back to Top

Examples

The following example submits a GET request.

API URL

 http://localhost:7010/ohfapi/cg/v3.3/genes/byHugoName?name=BID&name=EGFR&alignmentId=1

Example of Response Body

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

{
  "resourceType": "Genes",
  "items": [
    {
      "identifier": {
        "system": "ODB",
        "value": "22797"
      },
      "geneName": "ENSG00000015475",
      "hugoName": "BID",
      "assembly": "GRCh37",
      "chromosome": "22",
      "geneReference": {
        "reference": "/ohfapi/cg/v3.3/genes/22797"
      }
    },
    {
      "identifier": {
        "system": "ODB",
        "value": "50259"
      },
      "geneName": "ENSG00000146648",
      "hugoName": "EGFR",
      "assembly": "GRCh37",
      "chromosome": "7",
      "geneReference": {
        "reference": "/ohfapi/cg/v3.3/genes/50259"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/byHugoName?name=BID&name=EGFR&alignmentId=1"
    }
  ]
}

Back to Top