Help:WikiPathways Webservice/API

From WikiPathways

(Difference between revisions)
Jump to: navigation, search
Current revision (23:23, 9 November 2020) (view source)
(points to swagger now)
 
(47 intermediate revisions not shown.)
Line 2: Line 2:
  |__TOC__
  |__TOC__
  |}
  |}
-
=== Functions ===
 
-
{{WSFunction
 
-
|name=listOrganisms
 
-
|descr=Get a list of all available organisms.
 
-
|returns=
 
-
{{WSFunction/Return|type=array of string|descr=The names of the supported organisms.}}
 
-
}}
 
-
{{WSFunction
+
The WikiPathways Web API calls are documented using [https://webservice.wikipathways.org Swagger].  
-
|name=listPathways
+
For more information on libraries and code examples, see [[Help:WikiPathways_Webservice|WikiPathways web services]].
-
|descr=Get a list of all available pathways.
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSPathwayInfo|WSPathwayInfo]]|descr=The available pathways.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getPathway
+
-
|descr=Download the pathway from WikiPathways.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the pathway (use '0' for most recent version).}}
+
-
|returns=
+
-
{{WSFunction/Return|type=[[#WSPathway|WSPathway]]|descr=The pathway.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getPathwayInfo
+
-
|descr=Get some general info about the pathway, such as the name, species, without downloading the GPML.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=[[#WSPathwayInfo|WSPathwayInfo]]|descr=The pathway info.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getPathwayHistory
+
-
|descr=Get the revision history of a pathway.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=timestamp|type=string|descr=Limit the results by date, only history items after the given timestamp will be included.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=[[#WSPathwayHistory|WSPathwayHistory]]|descr=The revision history.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getRecentChanges
+
-
|descr=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.
+
-
 
+
-
 
+
-
|args=
+
-
{{WSFunction/Argument|name=timestamp|type=string|descr=Only get changes from after this time. Timestamp format: yyyymmddMMHHSS.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSPathwayInfo|WSPathwayInfo]]|descr=The changed pathways.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=login
+
-
|descr=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).
+
-
|args=
+
-
{{WSFunction/Argument|name=name|type=string|descr=The username of the WikiPathways account.}}
+
-
{{WSFunction/Argument|name=pass|type=string|descr=The password of the WikiPathways account.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=string|descr=The authentication code for this session.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getPathwayAs
+
-
|descr=Download a pathway in the specified file format.
+
-
|args=
+
-
{{WSFunction/Argument|name=fileType|type=string|descr=Download a pathway in the specified file format.
+
-
* gpml
+
-
* png
+
-
* svg
+
-
* pdf
+
-
* txt
+
-
* pwf
+
-
See [[Download_Pathways | the download page]] for an explanation of these file formats.}}
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the pathway (use '0' for most recent version).}}
+
-
|returns=
+
-
{{WSFunction/Return|type=base64Binary|descr=The file contents (base64 encoded).}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=updatePathway
+
-
|descr=Update a pathway on the wiki with the given GPML code.
+
-
 
+
-
{{WSWriteAccess}}
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=description|type=string|descr=A description of the modifications.}}
+
-
{{WSFunction/Argument|name=gpml|type=string|descr=The updated GPML code.}}
+
-
{{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=auth|type=object [[#WSAuth|WSAuth]]|descr=The authentication info.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=boolean|descr=True if the pathway was updated successfully.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=createPathway
+
-
|descr=Create a new pathway on the wiki with the given GPML code.
+
-
 
+
-
{{WSWriteAccess}}
+
-
|args=
+
-
{{WSFunction/Argument|name=gpml|type=string|descr=The GPML code.}}
+
-
{{WSFunction/Argument|name=auth|type=object [[#WSAuth|WSAuth]]|descr=The authentication info.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=[[#WSPathwayInfo|WSPathwayInfo]]|descr=The pathway info for the created pathway (containing identifier, revision, etc.).}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=findPathwaysByText
+
-
|descr=Find pathways using a textual search on the description and text labels of the pathway objects.
+
-
|args=
+
-
{{WSFunction/Argument|name=query|type=string|descr=The search query (e.g. 'apoptosis' or 'p53').}}
+
-
{{WSFunction/Argument|name=species|type=string|descr=The species to limit the search to (leave blank to search on all species).}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=findPathwaysByXref
+
-
|descr=Find pathways by searching on the external references of DataNodes (gene/protein/metabolite identifiers).
+
-
|args=
+
-
{{WSFunction/Argument|name=id|type=string|descr=The DataNode identifier (e.g. 'P45985').}}
+
-
{{WSFunction/Argument|name=code|type=string|descr=The code of the database system to limit the search to. Leave blank to search on all database systems. See [http://www.pathvisio.org/Help_1.1#Supported_database_systems this page] for an overview of available system codes.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results with DataNode graphId stored in the 'field' hash.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=findInteractions
+
-
|descr=Find interactions defined in WikiPathways pathways.
+
-
|args=
+
-
{{WSFunction/Argument|name=query|type=string|descr=The name of an entity to find interactions for (e.g. 'P53')}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]]|descr=An array of search results with interaction information stored in the 'field' array of hashes (group objects are stored as arrays).}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=saveCurationTag
+
-
|descr=Apply a curation tag to a pahtway. This operation will overwrite any existing tag with the same name.
+
-
 
+
-
{{WSWriteAccess}}
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=tagName|type=string|descr=The name of the tag to apply.}}
+
-
{{WSFunction/Argument|name=tagText|type=string|descr=The tag text (optional).}}
+
-
{{WSFunction/Argument|name=revision|type=integer|descr=The revision this tag applies to.}}
+
-
{{WSFunction/Argument|name=auth|type=object [[#WSAuth|WSAuth]]|descr=The authentication info.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=boolean|descr=True if the tag was saved successfully.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=removeCurationTag
+
-
|descr=Remove a curation tag from a pathway.
+
-
 
+
-
{{WSWriteAccess}}
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=tagName|type=string|descr=The name of the tag to remove.}}
+
-
{{WSFunction/Argument|name=auth|type=object [[#WSAuth|WSAuth]]|descr=The authentication info.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=boolean|descr=True if the tag was removed successfully.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getCurationTags
+
-
|descr=Get all curation tags for the given pathway.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSCurationTag|WSCurationTag]]|descr=The curation tags.}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getColoredPathway
+
-
|descr=Get a colored image version of the pathway.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=revision|type=integer|descr=The revision number of the pathway (use '0' for most recent version).}}
+
-
{{WSFunction/Argument|name=graphId|type=array of string|descr=An array with graphIds of the objects to color.}}
+
-
{{WSFunction/Argument|name=color|type=array of string|descr=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).}}
+
-
{{WSFunction/Argument|name=fileType|type=string|descr=The image type (One of 'svg', 'pdf' or 'png').}}
+
-
|returns=
+
-
{{WSFunction/Return|type=base64Binary|descr=The image data (base64 encoded).}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=getXrefList
+
-
|descr=Get a list of external references on the pathway (gene, protein or metabolite ids), translated to the given database system.
+
-
|args=
+
-
{{WSFunction/Argument|name=pwId|type=string|descr=The pathway identifier.}}
+
-
{{WSFunction/Argument|name=code|type=string|descr=The code of the system to translate to (e.g. 'S' for UniProt).}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of string|descr=The external references (ids)}}
+
-
}}
+
-
 
+
-
{{WSFunction
+
-
|name=findPathwaysByLiterature
+
-
|descr=Find pathways by their literature references.
+
-
|args=
+
-
{{WSFunction/Argument|name=query|type=string|descr=The query, can be a pubmed id, author name or title keyword.}}
+
-
|returns=
+
-
{{WSFunction/Return|type=array of [[#WSSearchResult|WSSearchResult]] descr=The search results.}}
+
-
}}
+
-
 
+
-
----
+
-
 
+
-
=== Objects ===
+
-
This section explains the different object classes defined in the WSDL.
+
-
 
+
-
{{WSObject
+
-
|name=WSPathwayInfo
+
-
|descr=Container for pathway metadata, such as name, organism and url.
+
-
|fields={{WSObject/Field
+
-
|name=id
+
-
|type=string
+
-
|descr=The pathway identifier
+
-
}}
+
-
{{WSObject/Field
+
-
|name=name
+
-
|type=string
+
-
|descr=The name of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=species
+
-
|type=string
+
-
|descr=The species (organism) of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=revision
+
-
|type=string
+
-
|descr=The revision number of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=url
+
-
|type=string
+
-
|descr=The url to the pathway
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSPathway
+
-
|descr='''Extends WSPathwayInfo'''.
+
-
 
+
-
Container for pathway metadata and content. This object inherits all fields from WSPathwayInfo and
+
-
has one additional field:
+
-
|fields={{WSObject/Field
+
-
|name=gpml
+
-
|type=string
+
-
|descr=The content of the pathway (as [http://www.pathvisio.org/EverythingGPML GPML]).
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSPathwayHistory
+
-
|descr='''Extends WSPathwayInfo'''.
+
-
 
+
-
Container for pathway revision history. This object inherits all fields from WSPathwayInfo and
+
-
has one additional field:
+
-
|fields={{WSObject/Field
+
-
|name=history
+
-
|type=array of WSHistoryRow
+
-
|descr=The revision history of the pathway.
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSHistoryRow
+
-
|descr=Info about a single revision of a pathway.
+
-
|fields={{WSObject/Field
+
-
|name=revision
+
-
|type=string
+
-
|descr=The revision number of this revision
+
-
}}
+
-
{{WSObject/Field
+
-
|name=comment
+
-
|type=string
+
-
|descr=The edit description
+
-
}}
+
-
{{WSObject/Field
+
-
|name=user
+
-
|type=string
+
-
|descr=The username of the user that edited this revision
+
-
}}
+
-
{{WSObject/Field
+
-
|name=timestamp
+
-
|type=string
+
-
|descr=The timestamp of this revision
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSAuth
+
-
|descr=Container for authentication data for a logged in WikiPathways session.
+
-
|fields={{WSObject/Field
+
-
|name=user
+
-
|type=string
+
-
|descr=The username of a WikiPathways account
+
-
}}
+
-
{{WSObject/Field
+
-
|name=key
+
-
|type=string
+
-
|descr=The authentication key of the session (can be obtained by calling the login function).
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSSearchResult
+
-
|descr=Container for a single search result.
+
-
|fields={{WSObject/Field
+
-
|name=score
+
-
|type=double
+
-
|descr=The score of the search result
+
-
}}
+
-
{{WSObject/Field
+
-
|name=id
+
-
|type=string
+
-
|descr=The pathway identifier
+
-
}}
+
-
{{WSObject/Field
+
-
|name=name
+
-
|type=string
+
-
|descr=The name of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=species
+
-
|type=string
+
-
|descr=The species (organism) of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=revision
+
-
|type=string
+
-
|descr=The revision number of the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=url
+
-
|type=string
+
-
|descr=The url to the pathway
+
-
}}
+
-
{{WSObject/Field
+
-
|name=fields
+
-
|type=array of WSIndexField
+
-
|descr=An array of index fields that were returned with the search. The included fields vary among different search functions. For example, it includes an array of hashes of arrays to represent interactions involving grouped objects.
+
-
}}
+
-
}}
+
-
 
+
-
{{WSObject
+
-
|name=WSIndexField
+
-
|descr=Container for a single index field.
+
-
|fields={{WSObject/Field
+
-
|name=name
+
-
|type=string
+
-
|descr=The name of the index field.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=values
+
-
|type=array of string
+
-
|descr=An array with the value(s) of the field.
+
-
}}
+
-
}}
+
-
 
+
-
 
+
-
{{WSObject
+
-
|name=WSCurationTag
+
-
|descr=Container for a single index field.
+
-
|fields=
+
-
{{WSObject/Field
+
-
|name=name
+
-
|type=string
+
-
|descr=The internal tag name.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=displayName
+
-
|type=string
+
-
|descr=The display name of the tag.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=pathway
+
-
|type=object [[#WSPathwayInfo|WSPathwayInfo]]
+
-
|descr=The pathway this tag applies to.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=revision
+
-
|type=string
+
-
|descr=The revision this tag applies to. '0' is used for tags that apply to all revisions.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=text
+
-
|type=string
+
-
|descr=The tag text.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=timeModified
+
-
|type=long
+
-
|descr=The timestamp of the last modified date.
+
-
}}
+
-
{{WSObject/Field
+
-
|name=userModified
+
-
|type=string
+
-
|descr=The username of the user that last modified the tag.
+
-
}}
+
-
}}
+
-
 
+
-
----
+
-
[[Help:WikiPathways_Webservice|Return to Web Services help page]]
+

Current revision

The WikiPathways Web API calls are documented using Swagger. For more information on libraries and code examples, see WikiPathways web services.

Retrieved from "https://classic.wikipathways.org/index.php/Help:WikiPathways_Webservice/API"
Personal tools