Retrieve CDS Components for a Gene Identifier
get
/ohfapi/cg/v3.3/genes/{id}/components/CDS
This endpoint supports the retrieval of CDS Components for a Gene Row ID passed. It returns all CDS Component information like Gene Name, Ensembl Version, Transcript Identifier, Component Name, Component Identifier, Genomic Positions, Strand and other CDS Component associated information. The 'Count' value displayed in the API represents the count of unique Gene Structure Identifiers
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
gene row ID
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
Response
Supported Media Types
- application/json
- application/xml
200 Response
successful operation
Model for paginated collections of data.
Root Schema : PageableCollectionGeneComponentSource
Type:
objectModel for paginated collections of data.
Show Source
-
count(optional):
integer(int64)
Number of objects in the 'items' collection.
-
hasMore(optional):
boolean
Default Value:
falseA boolean indicating if more pages are available. -
items(optional):
array items
A collection of paged items.
-
links(optional):
array link
A collection of links containing hrefs to the current, next, and previous pages as applicable.
-
resourceType(optional):
string
Identify the resource type
Nested Schema : link
Type:
arrayA collection of links containing hrefs to the current, next, and previous pages as applicable.
Show Source
Example:
{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}Nested Schema : GeneComponentSource
Type:
Show Source
object-
componentSource(optional):
object Transcript
-
ensemblVersion(optional):
string
Ensembl Version. For ex.,GRCH37.75
-
geneName(optional):
string
Gene Name. For ex.,RN5S300
-
geneReference(optional):
object LinkedReference
-
identifier(optional):
object Identifier
Identifier assigned by a given system
Nested Schema : Transcript
Type:
Show Source
object-
componentTypes(optional):
array componentTypes
List of Component Types
-
transcriptId(optional):
string
Transcript ID
Nested Schema : Identifier
Type:
objectIdentifier assigned by a given system
Show Source
-
system(optional):
string
System which assigned this identifier
-
value(optional):
string
Identifier value
400 Response
Invalid parameters supplied
404 Response
Gene CDS component(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/components/CDS
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"resourceType": "GeneComponents",
"items": [
{
"identifier": {
"system": "ODB",
"value": "225732"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193257,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55220239,
"endPosition": 55220357,
"strand": "+",
"numberInSequence": 5
},
{
"chromosome": "7",
"startPosition": 55221704,
"endPosition": 55221845,
"strand": "+",
"numberInSequence": 6
},
{
"chromosome": "7",
"startPosition": 55223523,
"endPosition": 55223639,
"strand": "+",
"numberInSequence": 7
},
{
"chromosome": "7",
"startPosition": 55224226,
"endPosition": 55224352,
"strand": "+",
"numberInSequence": 8
},
{
"chromosome": "7",
"startPosition": 55224452,
"endPosition": 55224525,
"strand": "+",
"numberInSequence": 9
},
{
"chromosome": "7",
"startPosition": 55225356,
"endPosition": 55225446,
"strand": "+",
"numberInSequence": 10
},
{
"chromosome": "7",
"startPosition": 55227832,
"endPosition": 55228031,
"strand": "+",
"numberInSequence": 11
},
{
"chromosome": "7",
"startPosition": 55229192,
"endPosition": 55229324,
"strand": "+",
"numberInSequence": 12
},
{
"chromosome": "7",
"startPosition": 55231426,
"endPosition": 55231516,
"strand": "+",
"numberInSequence": 13
},
{
"chromosome": "7",
"startPosition": 55232973,
"endPosition": 55233130,
"strand": "+",
"numberInSequence": 14
},
{
"chromosome": "7",
"startPosition": 55238868,
"endPosition": 55238906,
"strand": "+",
"numberInSequence": 15
},
{
"chromosome": "7",
"startPosition": 55240676,
"endPosition": 55240817,
"strand": "+",
"numberInSequence": 16
},
{
"chromosome": "7",
"startPosition": 55241614,
"endPosition": 55241736,
"strand": "+",
"numberInSequence": 17
},
{
"chromosome": "7",
"startPosition": 55242415,
"endPosition": 55242513,
"strand": "+",
"numberInSequence": 18
},
{
"chromosome": "7",
"startPosition": 55248986,
"endPosition": 55249171,
"strand": "+",
"numberInSequence": 19
},
{
"chromosome": "7",
"startPosition": 55259412,
"endPosition": 55259567,
"strand": "+",
"numberInSequence": 20
},
{
"chromosome": "7",
"startPosition": 55260459,
"endPosition": 55260534,
"strand": "+",
"numberInSequence": 21
},
{
"chromosome": "7",
"startPosition": 55266410,
"endPosition": 55266556,
"strand": "+",
"numberInSequence": 22
},
{
"chromosome": "7",
"startPosition": 55268009,
"endPosition": 55268106,
"strand": "+",
"numberInSequence": 23
},
{
"chromosome": "7",
"startPosition": 55268881,
"endPosition": 55269048,
"strand": "+",
"numberInSequence": 24
},
{
"chromosome": "7",
"startPosition": 55269428,
"endPosition": 55269475,
"strand": "+",
"numberInSequence": 25
},
{
"chromosome": "7",
"startPosition": 55270210,
"endPosition": 55270458,
"strand": "+",
"numberInSequence": 26
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
},
{
"identifier": {
"system": "ODB",
"value": "225733"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193259,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55214299,
"endPosition": 55214433,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 5
},
{
"chromosome": "7",
"startPosition": 55220239,
"endPosition": 55220357,
"strand": "+",
"numberInSequence": 6
},
{
"chromosome": "7",
"startPosition": 55221704,
"endPosition": 55221845,
"strand": "+",
"numberInSequence": 7
},
{
"chromosome": "7",
"startPosition": 55223523,
"endPosition": 55223639,
"strand": "+",
"numberInSequence": 8
},
{
"chromosome": "7",
"startPosition": 55224226,
"endPosition": 55224352,
"strand": "+",
"numberInSequence": 9
},
{
"chromosome": "7",
"startPosition": 55224452,
"endPosition": 55224525,
"strand": "+",
"numberInSequence": 10
},
{
"chromosome": "7",
"startPosition": 55225356,
"endPosition": 55225446,
"strand": "+",
"numberInSequence": 11
},
{
"chromosome": "7",
"startPosition": 55227832,
"endPosition": 55228031,
"strand": "+",
"numberInSequence": 12
},
{
"chromosome": "7",
"startPosition": 55229192,
"endPosition": 55229324,
"strand": "+",
"numberInSequence": 13
},
{
"chromosome": "7",
"startPosition": 55231426,
"endPosition": 55231516,
"strand": "+",
"numberInSequence": 14
},
{
"chromosome": "7",
"startPosition": 55232973,
"endPosition": 55233130,
"strand": "+",
"numberInSequence": 15
},
{
"chromosome": "7",
"startPosition": 55236216,
"endPosition": 55236222,
"strand": "+",
"numberInSequence": 16
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
},
{
"identifier": {
"system": "ODB",
"value": "225735"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193263,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55214299,
"endPosition": 55214433,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 5
},
{
"chromosome": "7",
"startPosition": 55220239,
"endPosition": 55220357,
"strand": "+",
"numberInSequence": 6
},
{
"chromosome": "7",
"startPosition": 55221704,
"endPosition": 55221845,
"strand": "+",
"numberInSequence": 7
},
{
"chromosome": "7",
"startPosition": 55223523,
"endPosition": 55223639,
"strand": "+",
"numberInSequence": 8
},
{
"chromosome": "7",
"startPosition": 55224226,
"endPosition": 55224352,
"strand": "+",
"numberInSequence": 9
},
{
"chromosome": "7",
"startPosition": 55224452,
"endPosition": 55224525,
"strand": "+",
"numberInSequence": 10
},
{
"chromosome": "7",
"startPosition": 55225356,
"endPosition": 55225446,
"strand": "+",
"numberInSequence": 11
},
{
"chromosome": "7",
"startPosition": 55227832,
"endPosition": 55228031,
"strand": "+",
"numberInSequence": 12
},
{
"chromosome": "7",
"startPosition": 55229192,
"endPosition": 55229324,
"strand": "+",
"numberInSequence": 13
},
{
"chromosome": "7",
"startPosition": 55231426,
"endPosition": 55231516,
"strand": "+",
"numberInSequence": 14
},
{
"chromosome": "7",
"startPosition": 55232973,
"endPosition": 55233130,
"strand": "+",
"numberInSequence": 15
},
{
"chromosome": "7",
"startPosition": 55238000,
"endPosition": 55238237,
"strand": "+",
"numberInSequence": 16
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
},
{
"identifier": {
"system": "ODB",
"value": "225738"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193269,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55214299,
"endPosition": 55214433,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 5
},
{
"chromosome": "7",
"startPosition": 55220239,
"endPosition": 55220357,
"strand": "+",
"numberInSequence": 6
},
{
"chromosome": "7",
"startPosition": 55221704,
"endPosition": 55221845,
"strand": "+",
"numberInSequence": 7
},
{
"chromosome": "7",
"startPosition": 55223523,
"endPosition": 55223639,
"strand": "+",
"numberInSequence": 8
},
{
"chromosome": "7",
"startPosition": 55224226,
"endPosition": 55224352,
"strand": "+",
"numberInSequence": 9
},
{
"chromosome": "7",
"startPosition": 55224452,
"endPosition": 55224536,
"strand": "+",
"numberInSequence": 10
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
},
{
"identifier": {
"system": "ODB",
"value": "225743"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193278,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55214299,
"endPosition": 55214433,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 5
},
{
"chromosome": "7",
"startPosition": 55220239,
"endPosition": 55220357,
"strand": "+",
"numberInSequence": 6
},
{
"chromosome": "7",
"startPosition": 55221704,
"endPosition": 55221845,
"strand": "+",
"numberInSequence": 7
},
{
"chromosome": "7",
"startPosition": 55223523,
"endPosition": 55223639,
"strand": "+",
"numberInSequence": 8
},
{
"chromosome": "7",
"startPosition": 55224226,
"endPosition": 55224352,
"strand": "+",
"numberInSequence": 9
},
{
"chromosome": "7",
"startPosition": 55224452,
"endPosition": 55224525,
"strand": "+",
"numberInSequence": 10
},
{
"chromosome": "7",
"startPosition": 55225356,
"endPosition": 55225446,
"strand": "+",
"numberInSequence": 11
},
{
"chromosome": "7",
"startPosition": 55227832,
"endPosition": 55228031,
"strand": "+",
"numberInSequence": 12
},
{
"chromosome": "7",
"startPosition": 55229192,
"endPosition": 55229324,
"strand": "+",
"numberInSequence": 13
},
{
"chromosome": "7",
"startPosition": 55231426,
"endPosition": 55231516,
"strand": "+",
"numberInSequence": 14
},
{
"chromosome": "7",
"startPosition": 55232973,
"endPosition": 55233130,
"strand": "+",
"numberInSequence": 15
},
{
"chromosome": "7",
"startPosition": 55238868,
"endPosition": 55238906,
"strand": "+",
"numberInSequence": 16
},
{
"chromosome": "7",
"startPosition": 55240676,
"endPosition": 55240817,
"strand": "+",
"numberInSequence": 17
},
{
"chromosome": "7",
"startPosition": 55241614,
"endPosition": 55241736,
"strand": "+",
"numberInSequence": 18
},
{
"chromosome": "7",
"startPosition": 55242415,
"endPosition": 55242513,
"strand": "+",
"numberInSequence": 19
},
{
"chromosome": "7",
"startPosition": 55248986,
"endPosition": 55249171,
"strand": "+",
"numberInSequence": 20
},
{
"chromosome": "7",
"startPosition": 55259412,
"endPosition": 55259567,
"strand": "+",
"numberInSequence": 21
},
{
"chromosome": "7",
"startPosition": 55260459,
"endPosition": 55260534,
"strand": "+",
"numberInSequence": 22
},
{
"chromosome": "7",
"startPosition": 55266410,
"endPosition": 55266556,
"strand": "+",
"numberInSequence": 23
},
{
"chromosome": "7",
"startPosition": 55268009,
"endPosition": 55268106,
"strand": "+",
"numberInSequence": 24
},
{
"chromosome": "7",
"startPosition": 55268881,
"endPosition": 55269048,
"strand": "+",
"numberInSequence": 25
},
{
"chromosome": "7",
"startPosition": 55269428,
"endPosition": 55269475,
"strand": "+",
"numberInSequence": 26
},
{
"chromosome": "7",
"startPosition": 55270210,
"endPosition": 55270318,
"strand": "+",
"numberInSequence": 27
},
{
"chromosome": "7",
"startPosition": 55272949,
"endPosition": 55273310,
"strand": "+",
"numberInSequence": 28
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
},
{
"identifier": {
"system": "ODB",
"value": "225753"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "CDS",
"componentId": 1193296,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55086971,
"endPosition": 55087058,
"strand": "+",
"numberInSequence": 1
},
{
"chromosome": "7",
"startPosition": 55209979,
"endPosition": 55210130,
"strand": "+",
"numberInSequence": 2
},
{
"chromosome": "7",
"startPosition": 55210998,
"endPosition": 55211181,
"strand": "+",
"numberInSequence": 3
},
{
"chromosome": "7",
"startPosition": 55214299,
"endPosition": 55214433,
"strand": "+",
"numberInSequence": 4
},
{
"chromosome": "7",
"startPosition": 55218987,
"endPosition": 55219055,
"strand": "+",
"numberInSequence": 5
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
}
],
"count": 6,
"hasMore": false,
"links": [
{
"rel": "self",
"href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/components/CDS"
}
]
}