Retrieve Drugs for a Gene Identifier
get
/ohfapi/cg/v3.3/genes/{id}/drugs
This endpoint supports the retrieval of Drugs for a Gene Row ID passed. It returns Drug information like Drug Name, Status, Reference Identifier, Database, Curation Source and other Drug associated information.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
id: integer(int64)
Minimum Value:
0
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
Root Schema : PageableCollection
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.
-
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:
array
A 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:
object
400 Response
Invalid parameters supplied
404 Response
Drug(s) not found
Examples
The following example submits a GET request.
API URL
http://localhost:7010/ohfapi/cg/v3.3/genes/50259/drugs
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "resourceType": "DrugGenes", "items": [ { "identifier": { "system": "ODB", "value": "1" }, "drugName": "Erlotinib,Lapatinib,Panitumumab,Matuzumab,Vandetanib,IGN311,CDX-110,N-[4-(3-BROMO-PHENYLAMINO)-QUINAZOLIN-6-YL]-ACRYLAMIDE,IMC-11F8,HuMax-EGFr,Cetuximab,Gefitinib,Trastuzumab,Afatinib,Lidocaine,Flavopiridol,S-{3-[(4-ANILINOQUINAZOLIN-6-YL)AMINO]-3-OXOPROPYL}-L-CYSTEINE,CI-1033,INSM-18", "status": "small molecule%2Capproved%2Cinvestigational,biotech%2Capproved%2Cinvestigational,biotech%2Cinvestigational,small molecule%2Capproved,small molecule%2Cinvestigational,small molecule%2Cexperimental,biotech%2Capproved,small molecule%2Cexperimental%2Cinvestigational,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A,N/A", "referenceId": "DB00530,DB01259,DB01269,DB05101,DB05294,DB04988,DB05374,DB07662,DB05774,DB05324,DB00002,DB00317,DB00072,DB08916,DB00281,DB03496,DB07602,DB05424,DB05900", "database": "DRUGBANK", "curationSource": "BIOBASE", "dnaReferenceVersion": "GRCH37.75", "geneRef": { "reference": "/HSDataService-web/api/3.2.0/genes/50259" } } ], "count": 1, "hasMore": false, "links": [ { "rel": "self", "href": "http://localhost:7010/ohfapi/cg/v3.3/genes/50259/drugs" } ] }