BioGRID ORCS REST Service
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
orcs:webservice [2018/02/23 19:30] biogridadmin [Examples] |
orcs:webservice [2018/08/29 20:39] biogridadmin |
||
|---|---|---|---|
| Line 6: | Line 6: | ||
| To access the BioGRID ORCS REST webservice, you will need a unique access key for your application. You can get one by filling out the simple form located **[[https://orcsws.thebiogrid.org|here]]**. This key must be included in all queries to the webservice in the form of accesskey=[ACCESSKEY]. | To access the BioGRID ORCS REST webservice, you will need a unique access key for your application. You can get one by filling out the simple form located **[[https://orcsws.thebiogrid.org|here]]**. This key must be included in all queries to the webservice in the form of accesskey=[ACCESSKEY]. | ||
| - | === End Points === | + | === Code Examples === |
| - | A formal description of the REST service, in Web Application Description Language (WADL), can be found at **https://orcsws.thebiogrid.org/application.wadl**. | + | For example code (written in Python) demonstrating basic usage of the REST Service, please visit our [[https://github.com/BioGRID/ORCS-REST-EXAMPLES|github repository]]. |
| === /organisms/ - Fetching Supported Organisms List === | === /organisms/ - Fetching Supported Organisms List === | ||
| Line 54: | Line 54: | ||
| |throughput|string|empty|Pipe-separated list of **throughput** vocab terms from ([[https://orcsws.thebiogrid.org/vocab/1?accesskey=[ACCESSKEY]]]) (only if required)| Enter throughput terms you want to search for, invalid throughput terms will be ignored. (eg. throughput=high throughput%%|%%low throughput ) | | |throughput|string|empty|Pipe-separated list of **throughput** vocab terms from ([[https://orcsws.thebiogrid.org/vocab/1?accesskey=[ACCESSKEY]]]) (only if required)| Enter throughput terms you want to search for, invalid throughput terms will be ignored. (eg. throughput=high throughput%%|%%low throughput ) | | ||
| |experimentalSetup|string|empty|Pipe-separated list of **experimental setup** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/3?accesskey=[ACCESSKEY]]]| Enter experimental setup terms you want to search for, invalid terms will be ignored. (eg. experimentalSetup=toxin exposure ) | | |experimentalSetup|string|empty|Pipe-separated list of **experimental setup** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/3?accesskey=[ACCESSKEY]]]| Enter experimental setup terms you want to search for, invalid terms will be ignored. (eg. experimentalSetup=toxin exposure ) | | ||
| - | |drugName|string|empty|Pipe-separated list of **drug name** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/4?accesskey=[ACCESSKEY]]]| Enter drug name terms you want to search for, invalid terms will be ignored. (eg. drugName=ricin%%|%%insulin ) | | + | |conditionName|string|empty|Pipe-separated list of **condition name** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/4?accesskey=[ACCESSKEY]]]| Enter condition name terms you want to search for, invalid terms will be ignored. (eg. conditionName=ricin%%|%%insulin ) | |
| - | |crisprLibrary|string|empty|Pipe-separated list of **CRISPR Library** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/5?accesskey=[ACCESSKEY]]]| Enter CRISPR Library terms you want to search for, invalid terms will be ignored. (eg. crisprLibrary=gecko%%|%%gecko v2 ) | | + | |libraryName|string|empty|Pipe-separated list of **library name** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/5?accesskey=[ACCESSKEY]]]| Enter Library terms you want to search for, invalid terms will be ignored. (eg. libraryName=gecko%%|%%gecko v2 ) | |
| - | |crisprLibraryType|string|empty|Pipe-separated list of **CRISPR Library Type** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/6?accesskey=[ACCESSKEY]]]| Enter CRISPR Library Type terms you want to search for, invalid terms will be ignored. (eg. crisprLibraryType=crispra ) | | + | |libraryType|string|empty|Pipe-separated list of **Library Type** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/6?accesskey=[ACCESSKEY]]]| Enter Library Type terms you want to search for, invalid terms will be ignored. (eg. libraryType=crispra ) | |
| - | |crisprMethodology|string|empty|Pipe-separated list of **CRISPR Methodology** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/7?accesskey=[ACCESSKEY]]]| Enter CRISPR Methodology terms you want to search for, invalid terms will be ignored. (eg. crisprMethodology=knockout%%|%%inhibition ) | | + | |libraryMethodology|string|empty|Pipe-separated list of **Library Methodology** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/7?accesskey=[ACCESSKEY]]]| Enter Library Methodology terms you want to search for, invalid terms will be ignored. (eg. libraryMethodology=knockout%%|%%inhibition ) | |
| |screenFormat|string|empty|Pipe-separated list of **screen format** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/8?accesskey=[ACCESSKEY]]]| Enter screen format terms you want to search for, invalid terms will be ignored. (eg. screenFormat=array ) | | |screenFormat|string|empty|Pipe-separated list of **screen format** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/8?accesskey=[ACCESSKEY]]]| Enter screen format terms you want to search for, invalid terms will be ignored. (eg. screenFormat=array ) | | ||
| |enzyme|string|empty|Pipe-separated list of **enzyme** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/9?accesskey=[ACCESSKEY]]]| Enter enzyme terms you want to search for, invalid terms will be ignored. (eg. enzyme=cas9%%|%%suncas9 ) | | |enzyme|string|empty|Pipe-separated list of **enzyme** vocabulary terms from [[https://orcsws.thebiogrid.org/vocab/9?accesskey=[ACCESSKEY]]]| Enter enzyme terms you want to search for, invalid terms will be ignored. (eg. enzyme=cas9%%|%%suncas9 ) | | ||
| Line 121: | Line 121: | ||
| === Screens with Cell Line of HELA and CRISPR Methodology of Knockout: === | === Screens with Cell Line of HELA and CRISPR Methodology of Knockout: === | ||
| - | **https://orcsws.thebiogrid.org/screens/?cellLine=hela&crisprMethodology=knockout&accesskey=[ACCESSKEY]** | + | **https://orcsws.thebiogrid.org/screens/?cellLine=hela&libraryMethodology=knockout&accesskey=[ACCESSKEY]** |
| === Screens with Phenotype of Viability or Toxin Resistance and Statistical Analysis Method of Castle, Bagel, or Mageck with header enabled in Human: === | === Screens with Phenotype of Viability or Toxin Resistance and Statistical Analysis Method of Castle, Bagel, or Mageck with header enabled in Human: === | ||