Search
From ToxBank API Wiki
(Difference between revisions)
m (Created page with "= Search = {{REST Operations |REST_op_description=Search in the default space |REST_op_method=GET |REST_op_uri=/query |REST_op_params=TBD, search parameters, page parameters |RE...") |
m |
||
| Line 6: | Line 6: | ||
|REST_op_uri=/query | |REST_op_uri=/query | ||
|REST_op_params=TBD, search parameters, page parameters | |REST_op_params=TBD, search parameters, page parameters | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | |REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | ||
|REST_op_result=URIs of the results, or in other supported format | |REST_op_result=URIs of the results, or in other supported format | ||
| Line 19: | Line 20: | ||
|REST_op_uri=/query/protocols | |REST_op_uri=/query/protocols | ||
|REST_op_params=TBD, search parameters, page parameters | |REST_op_params=TBD, search parameters, page parameters | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | |REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | ||
|REST_op_result=URIs of the protocols found, or in other supported format | |REST_op_result=URIs of the protocols found, or in other supported format | ||
| Line 32: | Line 34: | ||
|REST_op_uri=/query/study | |REST_op_uri=/query/study | ||
|REST_op_params=TBD, search parameters, page parameters | |REST_op_params=TBD, search parameters, page parameters | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | |REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | ||
|REST_op_result=URIs of the studies found, or in other supported format | |REST_op_result=URIs of the studies found, or in other supported format | ||
| Line 45: | Line 48: | ||
|REST_op_uri=/query/data | |REST_op_uri=/query/data | ||
|REST_op_params=TBD, search parameters, page parameters | |REST_op_params=TBD, search parameters, page parameters | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | |REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | ||
|REST_op_result=URIs of the datasets found, or in other supported format | |REST_op_result=URIs of the datasets found, or in other supported format | ||
| Line 58: | Line 62: | ||
|REST_op_uri=/query | |REST_op_uri=/query | ||
|REST_op_params=TBD | |REST_op_params=TBD | ||
| + | |REST_header_param=subjectid:SECURITY-TOKEN | ||
|REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | |REST_op_mime_input=application/x-www-form-urlencoded, RDF, JSON | ||
|REST_op_result=URI of the new query, e.g. /query/Q999 | |REST_op_result=URI of the new query, e.g. /query/Q999 | ||
Revision as of 17:18, 15 September 2011
Contents |
Search
| Description | Search in the default space |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /query |
| Parameters | TBD, search parameters, page parameters |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | application/x-www-form-urlencoded, RDF, JSON |
| Results | URIs of the results, or in other supported format |
| Media Type (output) | text/uri-list, RDF, JSON |
| Status code | 200,400,401,402,403 |
Search Protocols
| Description | Search in the default space |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /query/protocols |
| Parameters | TBD, search parameters, page parameters |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | application/x-www-form-urlencoded, RDF, JSON |
| Results | URIs of the protocols found, or in other supported format |
| Media Type (output) | text/uri-list, RDF, JSON |
| Status code | 200,400,401,402,403 |
Search Studies
| Description | Search in the default space |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /query/study |
| Parameters | TBD, search parameters, page parameters |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | application/x-www-form-urlencoded, RDF, JSON |
| Results | URIs of the studies found, or in other supported format |
| Media Type (output) | text/uri-list, RDF, JSON |
| Status code | 200,400,401,402,403 |
Search Data
| Description | Search in the default space |
|---|---|
| Resource | [[]] |
| Method | GET |
| URI | /query/data |
| Parameters | TBD, search parameters, page parameters |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | application/x-www-form-urlencoded, RDF, JSON |
| Results | URIs of the datasets found, or in other supported format |
| Media Type (output) | text/uri-list, RDF, JSON |
| Status code | 200,400,401,402,403 |
Create a predefined query
| Description | Create a predefined query |
|---|---|
| Resource | [[]] |
| Method | POST |
| URI | /query |
| Parameters | TBD |
| Header Parameters | subjectid:SECURITY-TOKEN |
| Media Type (input) | application/x-www-form-urlencoded, RDF, JSON |
| Results | URI of the new query, e.g. /query/Q999 |
| Media Type (output) | text/uri-list |
| Status code | 200,400,401,402,403 |
Alerts
TBD Create a predefined query, assign frequency to send alerts (by email?)
Facts about SearchRDF feed
| Acts on | |
| Has output media type | text/uri-list, RDF, JSON + and text/uri-list + |
| Has status code | 200,400,401,402,403 + |
