Help:WikiPathways Webservice

From WikiPathways

This page is under construction

WikiPathways can be accessed through a SOAP webservice. This page contains documentation for the webservice API.

Contents 1 WSDL 2 Objects 2.1 WSPathwayInfo 2.2 WSPathway 2.3 WSAuth 2.4 WSSearchResult 2.5 WSIndexField 3 Functions 3.1 listOrganisms 3.2 listPathways 3.3 getPathway 3.4 getRecentChanges 3.5 login 3.6 getPathwayAs 3.7 updatePathway 3.8 findPathwaysByText 3.9 findPathwaysByXref 4 Examples 4.1 Java 4.2 Taverna

WSDL

The WSDL file for the WikiPathways webservice can be downloaded from: http://www.wikipathways.org/wpi/webservice/webservice.php?wsdl

Objects

This section explains the different object classes defined in the WSDL.

WSPathwayInfo

Container for pathway metadata, such as name, organism and url.

fields
name	string	The name of the pathway
species	string	The species (organism) of the pathway
url	string	The url to the pathway
revision	string	The revision number of the pathway ('0' can be used for the most recent revision)

WSPathway

Extends WSPathwayInfo.

Container for pathway metadata and content. This object inherits all fields from WSPathwayInfo and has one additional field:

fields
gpml	string	The content of the pathway (as GPML).

WSAuth

Container for authentication data for a logged in WikiPathways session.

fields
user	string	The username of a WikiPathways account
key	string	The authentication key of the session (can be obtained by calling the login function).

WSSearchResult

Container for a single search result.

fields
score	double	The score of the search result
fields	array of object WSIndexField	An array of index fields that were returned with the search. The included fields may vary among different search functions.

WSIndexField

Container for a single index field.

fields
name	string	The name of the index field.
fields	array of string	An array with the value(s) of the field.

Functions

listOrganisms

Get a list of all available organisms.

returns
array of string	The names of the supported organisms

listPathways

Get a list of all available pathways.

returns
array of object WSPathwayInfo	The available pathways.

getPathway

getRecentChanges

login

getPathwayAs

updatePathway

findPathwaysByText

findPathwaysByXref

Examples

Java

Check out the subversion repository for example code on how to call the webservice from Java with Apache Axis 2.

Taverna

You can use the WikiPathways webservice to integrate WikiPathways functions in your Taverna workflows. See myexperiment.org for a set of example workflows that show how to call WikiPathways from Taverna.