Help:WikiPathways Webservice/API

From WikiPathways

(Difference between revisions)
Jump to: navigation, search
Line 24: Line 24:
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the pathway (use '0' for most recent version).}}
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the pathway (use '0' for most recent version).}}
|returns=
|returns=
-
{{WSFunction/Return|type=[[Help:WikiPathways_Webservice#WSPathway|WSPathway]]|descr=The pathway.}}
+
{{WSFunction/Return|type=[[#WSPathway|WSPathway]]|descr=The pathway.}}
}}
}}
Line 33: Line 33:
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
|returns=
|returns=
-
{{WSFunction/Return|type=[[Help:WikiPathways_Webservice#WSPathwayInfo|WSPathwayInfo]]|descr=The pathway info.}}
+
{{WSFunction/Return|type=[[#WSPathwayInfo|WSPathwayInfo]]|descr=The pathway info.}}
}}
}}
Line 46: Line 46:
{{WSFunction/Argument|name=timestamp|type=string|descr=Only get changes from after this time. Timestamp format: yyyymmddMMHHSS.}}
{{WSFunction/Argument|name=timestamp|type=string|descr=Only get changes from after this time. Timestamp format: yyyymmddMMHHSS.}}
|returns=
|returns=
-
{{WSFunction/Return|type=array of [[Help:WikiPathways_Webservice#WSPathwayInfo|WSPathwayInfo]]|descr=The changed pathways.}}
+
{{WSFunction/Return|type=array of [[#WSPathwayInfo|WSPathwayInfo]]|descr=The changed pathways.}}
}}
}}
Line 100: Line 100:
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.}}
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.}}
|returns=
|returns=
-
{{WSFunction/Return|type=array of [[Help:WikiPathways_Webservice#WSSearchResult|WSSearchResult]]|descr=An array of search results.}}
+
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results.}}
}}
}}
Line 112: Line 112:
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.}}
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.}}
|returns=
|returns=
-
{{WSFunction/Return|type=array of [[Help:WikiPathways_Webservice#WSSearchResult|WSSearchResult]]|descr=An array of search results.}}
+
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results.}}
}}
}}
Line 121: Line 121:
{{WSFunction/Argument|name=query|type=string|descr=The name of an entity to find interactions for (e.g. 'P53')}}
{{WSFunction/Argument|name=query|type=string|descr=The name of an entity to find interactions for (e.g. 'P53')}}
|returns=
|returns=
-
{{WSFunction/Return|type=array of [[Help:WikiPathways_Webservice#WSSearchResult|WSSearchResult]]|descr=An array of search results, containing the interaction information in the index fields.}}
+
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results, containing the interaction information in the index fields.}}
}}
}}

Revision as of 13:04, 17 December 2008

Contents

Functions

listOrganisms

Get a list of all available organisms.



listPathways

Get a list of all available pathways.



getPathway

Download the pathway from WikiPathways.


Arguments:

  • string pwId
    • The pathway identifier.
  • integer revision
    • The revision number of the pathway (use '0' for most recent version).


getPathwayInfo

Get some general info about the pathway, such as the name, species, without downloading the GPML.


Arguments:

  • string pwId
    • The pathway identifier.


getRecentChanges

Get the recently changed pathways.

Note: the recent changes table only retains items for a limited time (2 months), so there is no guarantee that you will get all changes when the timestamp points to a date that is more than 2 months in the past.


Arguments:

  • string timestamp
    • Only get changes from after this time. Timestamp format: yyyymmddMMHHSS.


login

Start a logged in session, using an existing WikiPathways account. This function will return an authentication code that can be used to excecute methods that need authentication (e.g. updatePathway).


Arguments:

  • string name
    • The username of the WikiPathways account.
  • string pass
    • The password of the WikiPathways account.


getPathwayAs

Download a pathway in the specified file format.


Arguments:

  • string fileType
    • Download a pathway in the specified file format.
  • gpml
  • png
  • svg
  • pdf
  • txt
  • pwf

See the download page for an explanation of these file formats.

  • string pwId
    • The pathway identifier.


updatePathway

Update a pathway on the wiki with the given GPML code.

Note: To create/modify pathways via the web service, you need to have an account with web service write permissions. Please contact us to request write access for the web service.


Arguments:

  • string pwId
    • The pathway identifier.
  • string description
    • A description of the modifications.
  • string pass
    • The updated GPML code.
  • integer revision
    • The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.
  • object WSAuth auth
    • The authentication info.


findPathwaysByText

Find pathways using a textual search on the description and text labels of the pathway objects.


Arguments:

  • string query
    • The search query (e.g. 'apoptosis' or 'p53').
  • string species
    • The species to limit the search to (leave blank to search on all species).
  • string pass
    • The updated GPML code.
  • integer revision
    • The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.


findPathwaysByXref

Find pathways by searching on the external references of DataNodes (gene/protein/metabolite identifiers).


Arguments:

  • string id
    • The DataNode identifier (e.g. 'P45985').
  • string code
    • The code of the database system to limit the search to. Leave blank to search on all database systems. See this page for an overview of available system codes.
  • string pass
    • The updated GPML code.
  • integer revision
    • The revision number of the version this GPML code was based on. This is used to prevent edit conflicts in case another client edited the pathway after this client downloaded it.


findInteractions

Find interactions defined in WikiPathways pathways.


Arguments:

  • string query
    • The name of an entity to find interactions for (e.g. 'P53')


saveCurationTag

Apply a curation tag to a pahtway. This operation will overwrite any existing tag with the same name.

Note: To create/modify pathways via the web service, you need to have an account with web service write permissions. Please contact us to request write access for the web service.


Arguments:

  • string pwId
    • The pathway identifier.
  • string tagName
    • The name of the tag to apply.
  • string tagText
    • The tag text (optional).
  • integer revision
    • The revision this tag applies to.
  • object WSAuth auth
    • The authentication info.


removeCurationTag

Remove a curation tag from a pathway.

Note: To create/modify pathways via the web service, you need to have an account with web service write permissions. Please contact us to request write access for the web service.


Arguments:

  • string pwId
    • The pathway identifier.
  • string tagName
    • The name of the tag to remove.
  • object WSAuth auth
    • The authentication info.


getCurationTags

Get all curation tags for the given pathway.


Arguments:

  • string pwId
    • The pathway identifier.


{{WSFunction |name=getColoredPathway |descr=Get a colored image version of the pathway. |args=

  • string pwId
    • The pathway identifier.
  • integer revision
    • The revision number of the pathway (use '0' for most recent version).
  • array of string graphId
    • An array with graphIds of the objects to color.
  • array of string graphId
    • An array with colors of the objects (should be the same length as graphId).

Colors should be encoded as a hexadecimal number, e.g. FF0000 for red).

  • string fileType
    • The image type (One of 'svg', 'pdf' or 'png').


Objects

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

WSPathwayInfo

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

Fields:

  • string id
    • The pathway identifier
  • string name
    • The name of the pathway
  • string species
    • The species (organism) of the pathway
  • string revision
    • 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:

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

WSAuth

Container for authentication data for a logged in WikiPathways session.

Fields:

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

WSSearchResult

Container for a single search result.

Fields:

  • double score
    • The score of the search result
  • array of WSIndexField fields
    • 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:

  • string name
    • The name of the index field.
  • array of string values
    • An array with the value(s) of the field.
Retrieved from "https://classic.wikipathways.org/index.php/Help:WikiPathways_Webservice/API"
Personal tools