-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathLINCS_Data_Portal_smartAPIs.json
419 lines (419 loc) · 14.1 KB
/
LINCS_Data_Portal_smartAPIs.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
{
"openapi": "3.0.0",
"info": {
"version": "1.0",
"title": "LINCS Data Portal API",
"description": "Documentation of the LINCS Data Portal web services. Learn more about [LINCS Data Portal](http://lincsportal.ccs.miami.edu/dcic-portal/)",
"termsOfService": "http://lincsportal.ccs.miami.edu/dcic-portal/#/terms",
"contact": {
"name": "UM BD2K-LINCS DCIC",
"x-role": "responsible organization",
"email": "[email protected]",
"x-id": "http://lincsportal.ccs.miami.edu/"
}
},
"servers": [
{
"url": "http://lincsportal.ccs.miami.edu/dcic/api/",
"description": "Production server"
}
],
"tags": [
{
"name": "small molecule"
},
{
"name": "query"
},
{
"name": "cells"
},
{
"name": "gene"
},
{
"name": "diseases"
},
{
"name": "LINCS"
},
{
"name": "SchuererLab"
},
{
"name": "signature"
}
],
"paths": {
"/fetchmolecules": {
"get": {
"tags": [
"small molecule",
"query",
"LINCS",
"SchuererLab"
],
"summary": "Get LINCS small molecule records, which contain both LINCS-based and general metadata about the small molecules tested in the NIH LINCS program. Parameter 'searchTerm' allows querying by specific metadata fields within small molecule records.",
"parameters": [
{
"name": "searchTerm",
"in": "query",
"description": "Parameter used for searching small molecule metadata fields. Syntax is \"field name:\"value\"\" Do Not include outer quotes. Example; Name:\"Imatinib\", lincsidentifier:\"LSM-1028\", etc. Setting search term equal to the wildcard charachter, \"*\", will query for all fields of all records up to the specified limit.",
"required": true,
"x-valueType": [
"http://identifiers.org/lincs.smallmolecule"
],
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a small molecule that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.smallmolecule",
"valueType": " http://identifiers.org/"
}
]
}
}
}
},
"/fetchcells": {
"get": {
"tags": [
"diseases",
"cells",
"query",
"LINCS",
"SchuererLab"
],
"summary": "Get LINCS cell lines records, which contain both LINCS-based and general metadata about the cell lines tested in the NIH LINCS program. Parameter 'searchTerm' allows querying by specific metadata fields within the cell line records.",
"parameters": [
{
"name": "searchTerm",
"in": "query",
"description": "Parameter used for searching cell line metadata fields. Syntax is \"field name:\"value\"\" Do Not include outer quotes. Example; Name:\"MCF7\", lincsidentifier:\"LSM-1028\", etc. Setting search term equal to the wildcard charachter, \"*\", will query for all fields of all records up to the specified limit.",
"required": true,
"x-valueType": [
" http://identifiers.org/lincs.cell"
],
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a cell line that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.cell",
"valueType": "http://identifiers.org/'"
}
]
}
}
}
},
"/fetchdata": {
"get": {
"tags": [
"signature",
"query",
"LINCS",
"SchuererLab"
],
"summary": "Get metadata for LINCS assay data sets (DOES NOT RETURN ASSAY ENDPOINT DATA). Parameter 'searchTerm' allows querying by specific metadata fields within the assay metadata records.",
"parameters": [
{
"name": "searchTerm",
"in": "query",
"description": "Parameter used for searching data set metadata fields. Syntax is \"field name:\"value\"\" Do Not include outer quotes. Example; centerfullname:\"HMS LINCS (Harvard Medical School)\", technologies:\"Fluorescence imaging\", etc. Setting search term equal to the wildcard charachter, \"*\", will query for all fields of all records up to the specified limit.",
"required": true,
"x-valueType": [
"http://identifiers.org/lincs.data"
],
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a dataset that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.data",
"valueType": "http://identifiers.org/"
}
]
}
}
}
},
"/mechanismOfAction": {
"get": {
"tags": [
"query",
"LINCS",
"SchuererLab",
"small molecule"
],
"summary": "Get known mechanisms of action for LINCS small molecules.",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Parameter used to search by LINCS small molecule identifier. Syntax is \"id=LSM-#\" Do Not use quotes. Example; id=LSM-1008.",
"required": false,
"x-valueType": [
"http://identifiers.org/lincs.smallmolecule"
],
"schema": {
"type": "string"
}
},
{
"name": "moa",
"in": "query",
"description": "Parameter used to search by the full name of the mechanism of action. Syntax is \"moa=Mechanism name\" Do Not use quotes. Example; moa=Stem cell growth factor receptor inhibitor.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a mechanism of action that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.smallmolecule",
"valueType": "http://identifiers.org/"
}
]
}
}
}
},
"/bioactivity": {
"get": {
"tags": [
"signature",
"query",
"LINCS",
"SchuererLab",
"small molecule"
],
"summary": "Get known bioactivities for LINCS small molecules, these data are aggregated values resourced from the ChEMBL ver 23 database <https://www.ebi.ac.uk/chembl/>. The ChEMBL values were mined from numerous sources.",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Parameter used to search by LINCS small molecule identifier. Syntax is \"id=LSM-#\" Do Not use quotes. Example; id=LSM-1008.",
"required": false,
"x-valueType": [
"http://identifiers.org/lincs.smallmolecule"
],
"schema": {
"type": "string"
}
},
{
"name": "target",
"in": "query",
"description": "Parameter used to search by the biochemical assay target using the target's preferred gene symbol from UniProt. Syntax is \"target=GENE SYMBOL\" Do Not use quotes. Examples; target=BRAF; target=MAPK13; etc..",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "uniprot",
"in": "query",
"description": "Parameter used to search by the biochemical assay target using the target's UniProt accession number. Syntax is \"uniprot=accession number\" Do Not use quotes. Examples; uniprto=O15264; uniprot=P15056; etc..",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a bioactivity that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.smallmolecule",
"valueType": "http://identifiers.org/"
}
]
}
}
}
},
"/drugindication": {
"get": {
"tags": [
"signature",
"query",
"LINCS",
"SchuererLab",
"small molecule"
],
"summary": "Get known drug indications for LINCS small molecules, the indications are captured from both the Experimental Factor Ontology (EFO) and the Medical Subject Headings (MeSH) vocabularies. ",
"parameters": [
{
"name": "id",
"in": "query",
"description": "Parameter used to search by LINCS small molecule identifier. Syntax is \"id=LSM-#\" Do Not use quotes. Example; id=LSM-1008.",
"required": false,
"x-valueType": [
"http://identifiers.org/lincs.smallmolecule"
],
"schema": {
"type": "string"
}
},
{
"name": "efo",
"in": "query",
"description": "Parameter used to search by the EFO drug indication. Syntax is \"efo=Drug Indication\" Do Not use quotes. Example; efo=renal carcinoma",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "mesh",
"in": "query",
"description": "Parameter used to search by the MeSH drug indication. Syntax is \"efo=Drug Indication\" Do Not use quotes. Example; mesh=carcinoma, renal cell",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a drug indication that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.smallmolecule",
"valueType": "http://identifiers.org/"
}
]
}
}
}
},
"/disease": {
"get": {
"tags": [
"diseases",
"query",
"LINCS",
"SchuererLab",
"cells"
],
"summary": "Query for LINCS cell line identifiers by disease, the diseases are captured from the Disease Ontology (DO) vocabulary. ",
"parameters": [
{
"name": "disease",
"in": "query",
"description": "Parameter used to search by the DO disease name. Syntax is \"disease=disease name\" Do Not use quotes. Example; disease=breast carcinoma",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "doid",
"in": "query",
"description": "Parameter used to search by the DO identifier. Syntax is \"doid=DOID:#\" Do Not use quotes. Example; doid=DOID:3459",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"in": "query",
"description": "limit the number of records returned, default is 10",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "A query response object with 'documents' property, each document corresponds to a disease that matched the query criteria. ",
"x-responseValueType": [
{
"path": "lincs.cell",
"valueType": "http://identifiers.org/"
}
]
}
}
}
}
}
}