spacer
spacer

Differences

This shows you the differences between two versions of the page.

services:eb-eye_rest [2014/06/30 09:40]
ympark (172.22.68.30)
services:eb-eye_rest [2014/09/19 11:03] (current)
ympark (172.22.68.30)
Line 13: Line 13:
)) is a high-performance, full-featured text search engine using [[http://lucene.apache.org/|Apache Lucene]] technology to index EMBL-EBI databases in various formats (e.g. flat-files, XML dumps, OBO format, etc.) and provides very fast access to the EMBL-EBI's data resources. The system allows the user to search globally across all EMBL-EBI databases. There are three main interfaces to the EB-eye: )) is a high-performance, full-featured text search engine using [[http://lucene.apache.org/|Apache Lucene]] technology to index EMBL-EBI databases in various formats (e.g. flat-files, XML dumps, OBO format, etc.) and provides very fast access to the EMBL-EBI's data resources. The system allows the user to search globally across all EMBL-EBI databases. There are three main interfaces to the EB-eye:
-  * Web interface: ''http://www.ebi.ac.uk/ebisearch/'' +  * Web interface: [[http://www.ebi.ac.uk/ebisearch/|http://www.ebi.ac.uk/ebisearch/]] 
-  * REST: EB-eye(REST) +  * REST: EB-eye (REST) 
-  * SOAP: [[http://www.ebi.ac.uk/Tools/webservices/services/eb-eye|EB-eye(SOAP)]]+  * SOAP: [[http://www.ebi.ac.uk/Tools/webservices/services/eb-eye|EB-eye (SOAP)]]
\\ \\
The Web Services API offers programmatic access to most of the functionality available in the EB-eye search engine. The Web Services API offers programmatic access to most of the functionality available in the EB-eye search engine.
Line 94: Line 94:
^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id[,entry_id]*}''|| ^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id[,entry_id]*}''||
^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | | ^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | |
-^ | ''{entry_id}'' is the entry identifier (limit: 100)| |+^ | ''{entry_id}'' is the entry identifier or accession number (limit: 100)| |
^ | ''{fields}'' is the list of comma separated field ids to retrieve|optional | ^ | ''{fields}'' is the list of comma separated field ids to retrieve|optional |
^ | ''{fieldurl}'' indicates whether field links are included|optional (default: false) | ^ | ''{fieldurl}'' indicates whether field links are included|optional (default: false) |
Line 100: Line 100:
^ | ''{format}'' is the required data format| optional (default: xml)| ^ | ''{format}'' is the required data format| optional (default: xml)|
\\ \\
-For example to know whether the entries WAP_RAT and WAP_MOUSE exist in uniprot:+For example to know whether the entries WAP_RAT and WAP_MOUSE exist in Uniprot:
  * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/entry/WAP_RAT,WAP_MOUSE''   * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/entry/WAP_RAT,WAP_MOUSE''
 +\\
 +to know whether the entreis WAP_RAT and WAP_MOUSE exists with their accession numbers in Uniprot:
 +  * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/entry/P01174,P01173''
\\ \\
to get 'descAltName' and 'organism_scientific_name' field values of the results: to get 'descAltName' and 'organism_scientific_name' field values of the results:
Line 118: Line 121:
^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id}/xref'' || ^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id}/xref'' ||
^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | | ^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | |
-^ | ''{entry_id}'' is the entry identifier| |+^ | ''{entry_id}'' is the entry identifier or accession number| |
^ | ''{format}'' is the required data format| optional (default: xml)| ^ | ''{format}'' is the required data format| optional (default: xml)|
\\ \\
Line 124: Line 127:
^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id[,entry_id]*}/xref/{referenced_domain}'' || ^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/entry/{entry_id[,entry_id]*}/xref/{referenced_domain}'' ||
^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | | ^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | |
-^ | ''{entry_id}'' is the entry identifier| |+^ | ''{entry_id}'' is the entry identifier or accession number| |
^ | ''{size}'' is the number of entries to retrieve. (limit: 100) | optional (default: 15)| ^ | ''{size}'' is the number of entries to retrieve. (limit: 100) | optional (default: 15)|
^ | ''{start}'' is the index of the first entry in the results| optional (default: 0)| ^ | ''{start}'' is the index of the first entry in the results| optional (default: 0)|
Line 140: Line 143:
to get interpro entries referenced in 'WAP_RAT' and 'WAP_MOUSE' Uniprot entries: to get interpro entries referenced in 'WAP_RAT' and 'WAP_MOUSE' Uniprot entries:
  * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/entry/WAP_RAT,WAP_MOUSE/xref/interpro''   * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/entry/WAP_RAT,WAP_MOUSE/xref/interpro''
 +
 +
 +==== Auto complete ====
 +to get suggested words from a given term, use a URL of the form:
 +
 +^ URL | ''http://www.ebi.ac.uk/ebisearch/ws/rest/{domain}/autocomplete'' ||
 +^ Parameters| ''{domain}'' is the domain identifier (e.g. uniprot) | |
 +^ | ''{term}'' is a term to get suggestions, whose length should be more than 3 characters |  |
 +^ | ''{formated}''  indicates whether to include highlighted suggestions  | optional (default:false) |
 +^ | ''{format}'' is the required data format | optional (default: xml) |
 +\\
 +For example to get suggestions over a given term 'cance' from Uniprot dictionary:
 +  * ''http://www.ebi.ac.uk/ebisearch/ws/rest/uniprot/autocomplete?term=cand''
 +\\
===== Response format ===== ===== Response format =====
Line 174: Line 191:
===== Cross domain requests ===== ===== Cross domain requests =====
-The cross domain requests are restricted to specific origins so please contact us at <es-request@ebi.ac.uk> if you need to be allowed. +The cross domain requests are restricted to specific origins so please contact us at [[http://www.ebi.ac.uk/support/index.php?query=WebServices|EMBL-EBI Support]] if you need to be allowed.
Line 180: Line 197:
For more information about the syntax that can be used in the API query parameters see: For more information about the syntax that can be used in the API query parameters see:
-  * [[http://lucene.apache.org/core/4_8_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description|Apache Lucene query syntax]]+  * [[http://lucene.apache.org/core/4_9_0/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description|Apache Lucene query syntax]]
 +===== Sample examples =====
 +You can find sample examples using the RESTful Web Servies [[http://www.ebi.ac.uk/Tools/webservices/services/eb-eye_rest/examples|here]].
 
services/eb-eye_rest.1404117619.txt · Last modified: 2014/06/30 09:40 by ympark
spacer
spacer