{"note":"OpenAPI conversion -- returning structured metadata","name":"wikipathways-org","description":"WikiPathways Webservices","version":"1.0","base_url":"https://webservice.wikipathways.org/","endpoints":26,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api WikiPathways Webservices\n@base https://webservice.wikipathways.org/\n@version 1.0\n@auth ApiKey auth in query\n@common_fields {format: any}\n@endpoints 26\n@hint download_for_search\n@toc listOrganisms(1), listPathways(1), getPathway(1), getPathwayInfo(1), getPathwayHistory(1), getRecentChanges(1), login(1), updatePathway(1), createPathway(1), findPathwaysByText(1), findPathwaysByXref(1), removeCurationTag(1), saveCurationTag(1), getCurationTags(1), getCurationTagsByName(1), getCurationTagHistory(1), getColoredPathway(1), findInteractions(1), getXrefList(1), findPathwaysByLiterature(1), saveOntologyTag(1), removeOntologyTag(1), getOntologyTermsByPathway(1), getPathwaysByOntologyTerm(1), getPathwaysByParentOntologyTerm(1), getUserByOrcid(1)\n\n@group listOrganisms\n@endpoint GET /listOrganisms\n@desc listOrganisms\n@returns(200) everything ok\n\n@endgroup\n\n@group listPathways\n@endpoint GET /listPathways\n@desc listPathways\n@optional {organism: any # The organism to filter by (optional)}\n@returns(200) everything ok\n\n@endgroup\n\n@group getPathway\n@endpoint GET /getPathway\n@desc getPathway\n@required {pwId: any # The pathway identifier}\n@optional {revision: any # The revision number of the pathway (use 0 for most recent)}\n@returns(200) everything ok\n\n@endgroup\n\n@group getPathwayInfo\n@endpoint GET /getPathwayInfo\n@desc getPathwayInfoGet some general info about the pathway, such as the name, species, without downloading the GPML.\n@required {pwId: any # The pathway identifier}\n@returns(200) everything ok\n\n@endgroup\n\n@group getPathwayHistory\n@endpoint GET /getPathwayHistory\n@desc getPathwayHistoryGet the revision history of a pathway.\n@required {pwId: any # The pathway identifier, timestamp: any # Limit by time, only history items after the given}\n@returns(200) everything ok\n\n@endgroup\n\n@group getRecentChanges\n@endpoint GET /getRecentChanges\n@desc getRecentChangesGet 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.\n@required {timestamp: any # Get the changes after this time}\n@returns(200) everything ok\n\n@endgroup\n\n@group login\n@endpoint GET /login\n@desc loginStart 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).\n@required {name: any # The usernameset_include_path(get_include_path().PATH_SEPARATOR.realpath('../includes').PATH_SEPARATOR.realpath('../').PATH_SEPARATOR);, pass: any # The password}\n@returns(200) everything ok\n\n@endgroup\n\n@group updatePathway\n@endpoint GET /updatePathway\n@desc updatePathwayUpdate 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.\n@required {pwId: any # The pathway identifier, description: any # A description of the modifications, gpml: any # The updated GPML code, revision: any # The revision the GPML code is based on, auth: any # The authentication key, username: any # The username}\n@returns(200) everything ok\n\n@endgroup\n\n@group createPathway\n@endpoint POST /createPathway\n@desc createPathwayCreate a new 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.\n@required {gpml: any # The GPML code for the new pathway, auth: any # The authentication info, username: any # The user name}\n@returns(200) everything ok\n\n@endgroup\n\n@group findPathwaysByText\n@endpoint GET /findPathwaysByText\n@desc findPathwaysByText\n@required {query: any # The query, e.g. 'apoptosis'}\n@optional {species: any # Optional, limit the query by species. Leave}\n@returns(200) everything ok\n\n@endgroup\n\n@group findPathwaysByXref\n@endpoint GET /findPathwaysByXref\n@desc findPathwaysByXref\n@required {ids: any # string}\n@optional {codes: any # string}\n@returns(200) everything ok\n\n@endgroup\n\n@group removeCurationTag\n@endpoint GET /removeCurationTag\n@desc removeCurationTagRemove a curation tag from a pathway.\n@required {pwId: any # The pathway identifier, tagName: any # The name of the tag to apply, auth: any # The authentication data, username: any # The user name}\n@returns(200) everything ok\n\n@endgroup\n\n@group saveCurationTag\n@endpoint GET /saveCurationTag\n@desc saveCurationTag\n@required {pwId: any # The pathway identifier, tagName: any # The name of the tag to apply, text: any # string, revision: any # The revision this tag applies to, auth: any # The authentication key, username: any # The user name}\n@returns(200) everything ok\n\n@endgroup\n\n@group getCurationTags\n@endpoint GET /getCurationTags\n@desc getCurationTagsGet all curation tags for the given tag name. Use this method if you want to find all pathways that are tagged with a specific curation tag.\n@required {pwId: any # The pathway identifier}\n@returns(200) everything ok\n\n@endgroup\n\n@group getCurationTagsByName\n@endpoint GET /getCurationTagsByName\n@desc getCurationTagsByNameGet all curation tags for the given tag name. Use this method if you want to find all pathways that are tagged with a specific curation tag.\n@required {tagName: any # The tag name}\n@returns(200) everything ok\n\n@endgroup\n\n@group getCurationTagHistory\n@endpoint GET /getCurationTagHistory\n@desc getCurationTagHistory\n@required {pwId: any # The pathway identifier}\n@optional {timestamp: any # Only include history from after the given date}\n@returns(200) everything ok\n\n@endgroup\n\n@group getColoredPathway\n@endpoint GET /getColoredPathway\n@desc getColoredPathwayGet a colored image version of the pathway.\n@required {pwId: any # The pathway identifier, revision: any # The revision of the pathway (use '0' for most recent), graphId: any # string, color: any # string, fileType: any # The image type (One of 'svg', 'pdf' or 'png').}\n@returns(200) everything ok\n\n@endgroup\n\n@group findInteractions\n@endpoint GET /findInteractions\n@desc findInteractionsFind interactions defined in WikiPathways pathways.\n@required {query: any # The name of an entity to find interactions for (e.g. 'P53')}\n@returns(200) everything ok\n\n@endgroup\n\n@group getXrefList\n@endpoint GET /getXrefList\n@desc getXrefList\n@required {pwId: any # The pathway identifier., code: any # The database code to translate to (e.g. 'S' for UniProt).}\n@returns(200) everything ok\n\n@endgroup\n\n@group findPathwaysByLiterature\n@endpoint GET /findPathwaysByLiterature\n@desc findPathwaysByLiterature\n@required {query: any # The query, can be a pubmed id, author name or title keyword.}\n@returns(200) everything ok\n\n@endgroup\n\n@group saveOntologyTag\n@endpoint GET /saveOntologyTag\n@desc saveOntologyTag\n@required {pwId: any # The pathway identifier, term: any # The ontology term to apply, termId: any # The identifier of the term in the ontology, auth: any # The authentication key, user: any # The username}\n@returns(200) everything ok\n\n@endgroup\n\n@group removeOntologyTag\n@endpoint GET /removeOntologyTag\n@desc removeOntologyTag\n@required {pwId: any # The pathway identifier, termId: any # The ontology term identifier in the ontology, auth: any # The authentication key, user: any # The username}\n@returns(200) everything ok\n\n@endgroup\n\n@group getOntologyTermsByPathway\n@endpoint GET /getOntologyTermsByPathway\n@desc getOntologyTermsByPathway\n@required {pwId: any # The pathway identifier}\n@returns(200) everything ok\n\n@endgroup\n\n@group getPathwaysByOntologyTerm\n@endpoint GET /getPathwaysByOntologyTerm\n@desc getPathwaysByOntologyTerm\n@required {term: any # The Ontology term}\n@returns(200) everything ok\n\n@endgroup\n\n@group getPathwaysByParentOntologyTerm\n@endpoint GET /getPathwaysByParentOntologyTerm\n@desc getPathwaysByParentOntologyTerm\n@required {term: any # The Ontology term}\n@returns(200) everything ok\n\n@endgroup\n\n@group getUserByOrcid\n@endpoint GET /getUserByOrcid\n@desc getUserByOrcid\n@required {orcid: any # string}\n@returns(200) everything ok\n\n@endgroup\n\n@end\n"}