Search

From ToxBank API Wiki
(Difference between revisions)
Jump to: navigation, search
(Search Studies)
(Search Data)
Line 29: Line 29:
 
== Search Data==
 
== Search Data==
 
[[API_Data|Data]] [[API_Study#Assays|Assays]]
 
[[API_Data|Data]] [[API_Study#Assays|Assays]]
{{REST Operations
+
 
|REST_op_description=Search data
+
{{HasOperation |id=Query:SearchData}}
|REST_op_method=GET
+
|REST_op_uri=/query/data
+
|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_result=URIs of the datasets found, or in other supported format
+
|REST_op_mime_output=text/uri-list, RDF, JSON
+
|REST_op_status=200,400,401,402,403
+
}}
+
  
 
== Create a predefined query ==
 
== Create a predefined query ==

Revision as of 12:25, 7 October 2011

Search


Contents

Query

Query language

Options

(not mutually exclusive)

GET parameters: Free text search, language could be similar to Google advanced search

GET or POST parameters, defining SPARQL SPARQL

Search

Description Search an ad hoc query
Resource Search
Method GET
URI /search
Parameters See query language
Header Parameters subjectid:SECURITY-TOKEN
Media Type (input)
Results URIs of the results
Media Type (output) text/uri-list
Status code 200,400,401,402,403

Links: Page, Edit with form



Search Protocols

Protocols


Description Search protocols
Resource Query
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

Links: Page, Edit with form



Search Studies

Study

Description Search studies
Resource Query
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

Links: Page, Edit with form



Search Data

Data Assays


Description Search data
Resource Query
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

Links: Page, Edit with form



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


Keyword hierarchy

Web service access to ontologies

Filtering the query

TBD

Alerts

An Alert is defined by Query URI ,frequency and an User to be notified.

Facts about SearchRDF feed
Acts onQuery  +
HasOperationQuery:Search  +, Query:SearchProtocols  +, Query:SearchStudy  + and Query:SearchData  +
Has output media typetext/uri-list, RDF, JSON  + and text/uri-list  +
Has status code200,400,401,402,403  +
Personal tools