Retrieve STS Components for a Gene Identifier and Structure Identifier
get
/ohfapi/cg/v3.3/genes/{id}/{structure}/components/STS
This endpoint supports the retrieval of STS Components for a Gene Row ID and Structure Row ID passed. It returns STS Component information like Gene name, Ensembl Version, Transcript Identifier, Component Name, Component Identifier, Genomic Positions, Strand and other STS Component associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0gene row ID -
structure: integer(int64)
Minimum Value:
0structure 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
Root Schema : PageableCollection
Type:
objectModel 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.
-
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
Nested Schema : links
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 : Serializable
Type:
object400 Response
Invalid parameters supplied
404 Response
Gene STS component(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/components/STS
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"resourceType": "GeneComponents",
"items": [
{
"identifier": {
"system": "ODB",
"value": "225728"
},
"geneName": "ENSG00000146648",
"ensemblVersion": "GRCH37.75",
"componentSource": {
"componentType": [
{
"componentName": "STS",
"componentId": 1193144,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55302533,
"endPosition": 55302859,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193147,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55300931,
"endPosition": 55301216,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193150,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55279147,
"endPosition": 55279243,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193152,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55279028,
"endPosition": 55279170,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193155,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55278846,
"endPosition": 55278970,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193157,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55275980,
"endPosition": 55276261,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193160,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55275586,
"endPosition": 55275693,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193163,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55275394,
"endPosition": 55275702,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193165,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55274826,
"endPosition": 55275086,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193168,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55274021,
"endPosition": 55274516,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193170,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55273309,
"endPosition": 55273448,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193173,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55258086,
"endPosition": 55258210,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193176,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55252401,
"endPosition": 55252679,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193178,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55249579,
"endPosition": 55249730,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193181,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55249499,
"endPosition": 55249688,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193183,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55239290,
"endPosition": 55239632,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193184,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55239238,
"endPosition": 55239343,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193185,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55225228,
"endPosition": 55225413,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193187,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55196526,
"endPosition": 55196843,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193188,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55195711,
"endPosition": 55195784,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193189,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55185096,
"endPosition": 55185214,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193190,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55183826,
"endPosition": 55183905,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193192,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55174818,
"endPosition": 55174918,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193193,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55172944,
"endPosition": 55173283,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193194,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55162466,
"endPosition": 55162647,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193195,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55140212,
"endPosition": 55140509,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193196,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55134259,
"endPosition": 55134338,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193197,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55129179,
"endPosition": 55129437,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193198,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55125191,
"endPosition": 55125334,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193199,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55124832,
"endPosition": 55124967,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193200,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55123333,
"endPosition": 55123491,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193201,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55122799,
"endPosition": 55122974,
"strand": "-",
"numberInSequence": 1
}
]
},
{
"componentName": "STS",
"componentId": 1193202,
"genomicPosition": [
{
"chromosome": "7",
"startPosition": 55114120,
"endPosition": 55114240,
"strand": "-",
"numberInSequence": 1
}
]
}
]
},
"geneReference": {
"reference": "/ohfapi/cg/v3.3/genes/50259"
}
}
],
"count": 1,
"hasMore": false,
"links": [
{
"rel": "self",
"href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/components/STS"
}
]
}