| Line 1: |
Line 1: |
| − | <!-- API warnings and errors:
| |
| − | {
| |
| − | "warnings": {
| |
| − | "main": {
| |
| − | "warnings": "A POST request was made without a \"Content-Type\" header. This does not work reliably.\nSubscribe to the mediawiki-api-announce mailing list at \u003Chttps://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce\u003E for notice of API deprecations and breaking changes."
| |
| − | }
| |
| − | }
| |
| − | }
| |
| − | -->
| |
| − | <!DOCTYPE html>
| |
| − | <html class="client-nojs" lang="en" dir="ltr">
| |
| − | <head>
| |
| − | <meta charset="UTF-8"/>
| |
| − | <title>MediaWiki API help - Compendium of Cancer Genome Aberrations</title>
| |
| − | <script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":!0,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"92b68b192c8d405056932306","wgCSPNonce":!1,"wgCanonicalNamespace":"Special","wgCanonicalSpecialPageName":"ApiHelp","wgNamespaceNumber":-1,"wgPageName":"Special:ApiHelp","wgTitle":"ApiHelp","wgCurRevisionId":0,"wgRevisionId":0,"wgArticleId":0,"wgIsArticle":!1,"wgIsRedirect":!1,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"Special:ApiHelp","wgRelevantArticleId":0,"wgIsProbablyEditable":!1,"wgRelevantPageIsProbablyEditable":!1,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgEditSubmitButtonLabelPublish":
| |
| − | !1};RLSTATE={"site.styles":"ready","noscript":"ready","user.styles":"ready","user":"ready","user.options":"loading","mediawiki.hlist":"ready","mediawiki.apipretty":"ready","mediawiki.skinning.interface":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready"};RLPAGEMODULES=["site","mediawiki.page.startup","mediawiki.page.ready","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader"];</script>
| |
| − | <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.implement("user.options@1hzgi",function($,jQuery,require,module){/*@nomin*/mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"});
| |
| − | });});</script>
| |
| − | <link rel="stylesheet" href="/load.php?lang=en&modules=ext.visualEditor.desktopArticleTarget.noscript%7Cmediawiki.apipretty%2Chlist%7Cmediawiki.skinning.interface&only=styles&skin=apioutput"/>
| |
| − | <script async="" src="/load.php?lang=en&modules=startup&only=scripts&raw=1&skin=apioutput"></script>
| |
| − | <meta name="generator" content="MediaWiki 1.35.0"/>
| |
| − | <meta name="robots" content="noindex,nofollow"/>
| |
| − | <link rel="shortcut icon" href="/favicon.ico"/>
| |
| − | <link rel="search" type="application/opensearchdescription+xml" href="/opensearch_desc.php" title="Compendium of Cancer Genome Aberrations (en)"/>
| |
| − | <link rel="EditURI" type="application/rsd+xml" href="https://ccga.io/api.php?action=rsd"/>
| |
| − | <link rel="license" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright"/>
| |
| − | <link rel="alternate" type="application/atom+xml" title="Compendium of Cancer Genome Aberrations Atom feed" href="/index.php?title=Special:RecentChanges&feed=atom"/>
| |
| − | <!--[if lt IE 9]><script src="/resources/lib/html5shiv/html5shiv.js"></script><![endif]-->
| |
| − | </head>
| |
| − | <body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns--1 ns-special mw-special-ApiHelp page-Special_ApiHelp rootpage-Special_ApiHelp skin-apioutput action-view skin-vector-legacy"><div class="mw-body" role="main">
| |
| − | <h1 id="firstHeading">MediaWiki API help</h1>
| |
| − | <div class="mw-body-content">
| |
| − | <div id="mw-content-text"><p>This is an auto-generated MediaWiki API documentation page.
| |
| − | </p><p>Documentation and examples: <a class="external free" href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page</a>
| |
| − | </p><h2 class="apihelp-header" id="main">Main module</h2>
| |
| − | <div class="apihelp-block apihelp-flags"><ul><li><span class="apihelp-source">Source: <span dir="ltr" lang="en">MediaWiki</span></span></li><li><span class="apihelp-license">License: <a href="/index.php/Special:Version/License/MediaWiki" title="Special:Version/License/MediaWiki"><span dir="ltr" lang="en">GPL-2.0-or-later</span></a></span></li></ul></div>
| |
| − | <div class="hlist plainlinks api-main-links">
| |
| − | <ul><li><a href="http://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page" class="extiw" title="mw:Special:MyLanguage/API:Main page">Documentation</a></li>
| |
| − | <li><a href="http://www.mediawiki.org/wiki/Special:MyLanguage/API:FAQ" class="extiw" title="mw:Special:MyLanguage/API:FAQ">FAQ</a></li>
| |
| − | <li><a rel="nofollow" class="external text" href="https://lists.wikimedia.org/mailman/listinfo/mediawiki-api">Mailing list</a></li>
| |
| − | <li><a rel="nofollow" class="external text" href="https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce">API Announcements</a></li>
| |
| − | <li><a rel="nofollow" class="external text" href="https://phabricator.wikimedia.org/maniphest/query/GebfyV4uCaLd/#R">Bugs & requests</a></li></ul></div>
| |
| − | <p><strong>Status:</strong> The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to <a rel="nofollow" class="external text" href="https://lists.wikimedia.org/pipermail/mediawiki-api-announce/">the mediawiki-api-announce mailing list</a> for notice of updates.
| |
| − | </p><p><strong>Erroneous requests:</strong> When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see <a href="http://www.mediawiki.org/wiki/Special:MyLanguage/API:Errors_and_warnings" class="extiw" title="mw:Special:MyLanguage/API:Errors and warnings">API: Errors and warnings</a>.
| |
| − | </p>
| |
| − | <p class="mw-apisandbox-link"><strong>Testing:</strong> For ease of testing API requests, see <a href="/index.php/Special:ApiSandbox" title="Special:ApiSandbox">Special:ApiSandbox</a>.</p>
| |
| | | | |
| − | <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Parameters:</div><dl><dt><span dir="ltr" lang="en">action</span></dt><dd class="description"><p>Which action to perform.
| |
| − | </p><dl><dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=block">block</a></span></dt>
| |
| − | <dd>Block a user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=changeauthenticationdata">changeauthenticationdata</a></span></dt>
| |
| − | <dd>Change authentication data for the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=changecontentmodel">changecontentmodel</a></span></dt>
| |
| − | <dd>Change the content model of a page</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=checktoken">checktoken</a></span></dt>
| |
| − | <dd>Check the validity of a token from <kbd><a href="/api.php?action=help&modules=query%2Btokens">action=query&meta=tokens</a></kbd>.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=clearhasmsg">clearhasmsg</a></span></dt>
| |
| − | <dd>Clears the <code>hasmsg</code> flag for the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=clientlogin">clientlogin</a></span></dt>
| |
| − | <dd>Log in to the wiki using the interactive flow.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=compare">compare</a></span></dt>
| |
| − | <dd>Get the difference between two pages.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=createaccount">createaccount</a></span></dt>
| |
| − | <dd>Create a new user account.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=delete">delete</a></span></dt>
| |
| − | <dd>Delete a page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=edit">edit</a></span></dt>
| |
| − | <dd>Create and edit pages.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=emailuser">emailuser</a></span></dt>
| |
| − | <dd>Email a user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=expandtemplates">expandtemplates</a></span></dt>
| |
| − | <dd>Expands all templates within wikitext.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=feedcontributions">feedcontributions</a></span></dt>
| |
| − | <dd>Returns a user's contributions feed.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=feedrecentchanges">feedrecentchanges</a></span></dt>
| |
| − | <dd>Returns a recent changes feed.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=feedwatchlist">feedwatchlist</a></span></dt>
| |
| − | <dd>Returns a watchlist feed.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=filerevert">filerevert</a></span></dt>
| |
| − | <dd>Revert a file to an old version.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=help">help</a></span></dt>
| |
| − | <dd>Display help for the specified modules.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=imagerotate">imagerotate</a></span></dt>
| |
| − | <dd>Rotate one or more images.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=import">import</a></span></dt>
| |
| − | <dd>Import a page from another wiki, or from an XML file.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=linkaccount">linkaccount</a></span></dt>
| |
| − | <dd>Link an account from a third-party provider to the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=login">login</a></span></dt>
| |
| − | <dd>Log in and get authentication cookies.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=logout">logout</a></span></dt>
| |
| − | <dd>Log out and clear session data.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=managetags">managetags</a></span></dt>
| |
| − | <dd>Perform management tasks relating to change tags.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=mergehistory">mergehistory</a></span></dt>
| |
| − | <dd>Merge page histories.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=move">move</a></span></dt>
| |
| − | <dd>Move a page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=opensearch">opensearch</a></span></dt>
| |
| − | <dd>Search the wiki using the OpenSearch protocol.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=options">options</a></span></dt>
| |
| − | <dd>Change preferences of the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=paraminfo">paraminfo</a></span></dt>
| |
| − | <dd>Obtain information about API modules.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=parse">parse</a></span></dt>
| |
| − | <dd>Parses content and returns parser output.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=patrol">patrol</a></span></dt>
| |
| − | <dd>Patrol a page or revision.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=protect">protect</a></span></dt>
| |
| − | <dd>Change the protection level of a page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=purge">purge</a></span></dt>
| |
| − | <dd>Purge the cache for the given titles.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=query">query</a></span></dt>
| |
| − | <dd>Fetch data from and about MediaWiki.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=removeauthenticationdata">removeauthenticationdata</a></span></dt>
| |
| − | <dd>Remove authentication data for the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=resetpassword">resetpassword</a></span></dt>
| |
| − | <dd>Send a password reset email to a user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=revisiondelete">revisiondelete</a></span></dt>
| |
| − | <dd>Delete and undelete revisions.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=rollback">rollback</a></span></dt>
| |
| − | <dd>Undo the last edit to the page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=rsd">rsd</a></span></dt>
| |
| − | <dd>Export an RSD (Really Simple Discovery) schema.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=setnotificationtimestamp">setnotificationtimestamp</a></span></dt>
| |
| − | <dd>Update the notification timestamp for watched pages.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=setpagelanguage">setpagelanguage</a></span></dt>
| |
| − | <dd>Change the language of a page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=tag">tag</a></span></dt>
| |
| − | <dd>Add or remove change tags from individual revisions or log entries.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=templatedata">templatedata</a></span></dt>
| |
| − | <dd>Fetch data stored by the TemplateData extension.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=unblock">unblock</a></span></dt>
| |
| − | <dd>Unblock a user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=undelete">undelete</a></span></dt>
| |
| − | <dd>Restore revisions of a deleted page.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=unlinkaccount">unlinkaccount</a></span></dt>
| |
| − | <dd>Remove a linked third-party account from the current user.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=upload">upload</a></span></dt>
| |
| − | <dd>Upload a file, or get the status of pending uploads.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=userrights">userrights</a></span></dt>
| |
| − | <dd>Change a user's group membership.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=validatepassword">validatepassword</a></span></dt>
| |
| − | <dd>Validate a password against the wiki's password policies.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=watch">watch</a></span></dt>
| |
| − | <dd>Add or remove pages from the current user's watchlist.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=tokens">tokens</a></span></dt>
| |
| − | <dd><span class="apihelp-deprecated">Deprecated.</span> Get tokens for data-modifying actions.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=cspreport">cspreport</a></span></dt>
| |
| − | <dd><span class="apihelp-internal">Internal.</span> Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=scribunto-console">scribunto-console</a></span></dt>
| |
| − | <dd><span class="apihelp-internal">Internal.</span> Internal module for servicing XHR requests from the Scribunto console.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=stashedit">stashedit</a></span></dt>
| |
| − | <dd><span class="apihelp-internal">Internal.</span> Prepare an edit in shared cache.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=visualeditor">visualeditor</a></span></dt>
| |
| − | <dd><span class="apihelp-internal">Internal.</span> Returns HTML5 for a page from the Parsoid service.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=visualeditoredit">visualeditoredit</a></span></dt>
| |
| − | <dd><span class="apihelp-internal">Internal.</span> Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).</dd></dl></dd><dd class="info">One of the following values: <a href="/api.php?action=help&modules=block"><span dir="ltr" lang="en">block</span></a>, <a href="/api.php?action=help&modules=changeauthenticationdata"><span dir="ltr" lang="en">changeauthenticationdata</span></a>, <a href="/api.php?action=help&modules=changecontentmodel"><span dir="ltr" lang="en">changecontentmodel</span></a>, <a href="/api.php?action=help&modules=checktoken"><span dir="ltr" lang="en">checktoken</span></a>, <a href="/api.php?action=help&modules=clearhasmsg"><span dir="ltr" lang="en">clearhasmsg</span></a>, <a href="/api.php?action=help&modules=clientlogin"><span dir="ltr" lang="en">clientlogin</span></a>, <a href="/api.php?action=help&modules=compare"><span dir="ltr" lang="en">compare</span></a>, <a href="/api.php?action=help&modules=createaccount"><span dir="ltr" lang="en">createaccount</span></a>, <a href="/api.php?action=help&modules=delete"><span dir="ltr" lang="en">delete</span></a>, <a href="/api.php?action=help&modules=edit"><span dir="ltr" lang="en">edit</span></a>, <a href="/api.php?action=help&modules=emailuser"><span dir="ltr" lang="en">emailuser</span></a>, <a href="/api.php?action=help&modules=expandtemplates"><span dir="ltr" lang="en">expandtemplates</span></a>, <a href="/api.php?action=help&modules=feedcontributions"><span dir="ltr" lang="en">feedcontributions</span></a>, <a href="/api.php?action=help&modules=feedrecentchanges"><span dir="ltr" lang="en">feedrecentchanges</span></a>, <a href="/api.php?action=help&modules=feedwatchlist"><span dir="ltr" lang="en">feedwatchlist</span></a>, <a href="/api.php?action=help&modules=filerevert"><span dir="ltr" lang="en">filerevert</span></a>, <a href="/api.php?action=help&modules=help"><span dir="ltr" lang="en">help</span></a>, <a href="/api.php?action=help&modules=imagerotate"><span dir="ltr" lang="en">imagerotate</span></a>, <a href="/api.php?action=help&modules=import"><span dir="ltr" lang="en">import</span></a>, <a href="/api.php?action=help&modules=linkaccount"><span dir="ltr" lang="en">linkaccount</span></a>, <a href="/api.php?action=help&modules=login"><span dir="ltr" lang="en">login</span></a>, <a href="/api.php?action=help&modules=logout"><span dir="ltr" lang="en">logout</span></a>, <a href="/api.php?action=help&modules=managetags"><span dir="ltr" lang="en">managetags</span></a>, <a href="/api.php?action=help&modules=mergehistory"><span dir="ltr" lang="en">mergehistory</span></a>, <a href="/api.php?action=help&modules=move"><span dir="ltr" lang="en">move</span></a>, <a href="/api.php?action=help&modules=opensearch"><span dir="ltr" lang="en">opensearch</span></a>, <a href="/api.php?action=help&modules=options"><span dir="ltr" lang="en">options</span></a>, <a href="/api.php?action=help&modules=paraminfo"><span dir="ltr" lang="en">paraminfo</span></a>, <a href="/api.php?action=help&modules=parse"><span dir="ltr" lang="en">parse</span></a>, <a href="/api.php?action=help&modules=patrol"><span dir="ltr" lang="en">patrol</span></a>, <a href="/api.php?action=help&modules=protect"><span dir="ltr" lang="en">protect</span></a>, <a href="/api.php?action=help&modules=purge"><span dir="ltr" lang="en">purge</span></a>, <a href="/api.php?action=help&modules=query"><span dir="ltr" lang="en">query</span></a>, <a href="/api.php?action=help&modules=removeauthenticationdata"><span dir="ltr" lang="en">removeauthenticationdata</span></a>, <a href="/api.php?action=help&modules=resetpassword"><span dir="ltr" lang="en">resetpassword</span></a>, <a href="/api.php?action=help&modules=revisiondelete"><span dir="ltr" lang="en">revisiondelete</span></a>, <a href="/api.php?action=help&modules=rollback"><span dir="ltr" lang="en">rollback</span></a>, <a href="/api.php?action=help&modules=rsd"><span dir="ltr" lang="en">rsd</span></a>, <a href="/api.php?action=help&modules=setnotificationtimestamp"><span dir="ltr" lang="en">setnotificationtimestamp</span></a>, <a href="/api.php?action=help&modules=setpagelanguage"><span dir="ltr" lang="en">setpagelanguage</span></a>, <a href="/api.php?action=help&modules=tag"><span dir="ltr" lang="en">tag</span></a>, <a href="/api.php?action=help&modules=templatedata"><span dir="ltr" lang="en">templatedata</span></a>, <a href="/api.php?action=help&modules=unblock"><span dir="ltr" lang="en">unblock</span></a>, <a href="/api.php?action=help&modules=undelete"><span dir="ltr" lang="en">undelete</span></a>, <a href="/api.php?action=help&modules=unlinkaccount"><span dir="ltr" lang="en">unlinkaccount</span></a>, <a href="/api.php?action=help&modules=upload"><span dir="ltr" lang="en">upload</span></a>, <a href="/api.php?action=help&modules=userrights"><span dir="ltr" lang="en">userrights</span></a>, <a href="/api.php?action=help&modules=validatepassword"><span dir="ltr" lang="en">validatepassword</span></a>, <a href="/api.php?action=help&modules=watch"><span dir="ltr" lang="en">watch</span></a>, <a href="/api.php?action=help&modules=tokens"><span dir="ltr" lang="en" class="apihelp-deprecated-value">tokens</span></a>, <a href="/api.php?action=help&modules=cspreport"><span dir="ltr" lang="en" class="apihelp-internal-value">cspreport</span></a>, <a href="/api.php?action=help&modules=scribunto-console"><span dir="ltr" lang="en" class="apihelp-internal-value">scribunto-console</span></a>, <a href="/api.php?action=help&modules=stashedit"><span dir="ltr" lang="en" class="apihelp-internal-value">stashedit</span></a>, <a href="/api.php?action=help&modules=visualeditor"><span dir="ltr" lang="en" class="apihelp-internal-value">visualeditor</span></a>, <a href="/api.php?action=help&modules=visualeditoredit"><span dir="ltr" lang="en" class="apihelp-internal-value">visualeditoredit</span></a></dd><dd class="info">Default: help</dd><dt><span dir="ltr" lang="en">format</span></dt><dd class="description"><p>The format of the output.
| |
| − | </p><dl><dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=json">json</a></span></dt>
| |
| − | <dd>Output data in JSON format.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=jsonfm">jsonfm</a></span></dt>
| |
| − | <dd>Output data in JSON format (pretty-print in HTML).</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=none">none</a></span></dt>
| |
| − | <dd>Output nothing.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=php">php</a></span></dt>
| |
| − | <dd>Output data in serialized PHP format.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=phpfm">phpfm</a></span></dt>
| |
| − | <dd>Output data in serialized PHP format (pretty-print in HTML).</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=rawfm">rawfm</a></span></dt>
| |
| − | <dd>Output data, including debugging elements, in JSON format (pretty-print in HTML).</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=xml">xml</a></span></dt>
| |
| − | <dd>Output data in XML format.</dd>
| |
| − | <dt><span dir="ltr" lang="en"><a href="/api.php?action=help&modules=xmlfm">xmlfm</a></span></dt>
| |
| − | <dd>Output data in XML format (pretty-print in HTML).</dd></dl></dd><dd class="info">One of the following values: <a href="/api.php?action=help&modules=json"><span dir="ltr" lang="en">json</span></a>, <a href="/api.php?action=help&modules=jsonfm"><span dir="ltr" lang="en">jsonfm</span></a>, <a href="/api.php?action=help&modules=none"><span dir="ltr" lang="en">none</span></a>, <a href="/api.php?action=help&modules=php"><span dir="ltr" lang="en">php</span></a>, <a href="/api.php?action=help&modules=phpfm"><span dir="ltr" lang="en">phpfm</span></a>, <a href="/api.php?action=help&modules=rawfm"><span dir="ltr" lang="en">rawfm</span></a>, <a href="/api.php?action=help&modules=xml"><span dir="ltr" lang="en">xml</span></a>, <a href="/api.php?action=help&modules=xmlfm"><span dir="ltr" lang="en">xmlfm</span></a></dd><dd class="info">Default: jsonfm</dd><dt><span dir="ltr" lang="en">maxlag</span></dt><dd class="description"><p>Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code <samp>maxlag</samp> is returned with a message like <samp>Waiting for $host: $lag seconds lagged</samp>.<br>See <a href="http://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Maxlag_parameter" class="extiw" title="mw:Special:MyLanguage/Manual:Maxlag parameter">Manual: Maxlag parameter</a> for more information.
| |
| − | </p></dd><dd class="info">Type: integer</dd><dt><span dir="ltr" lang="en">smaxage</span></dt><dd class="description"><p>Set the <code>s-maxage</code> HTTP cache control header to this many seconds. Errors are never cached.
| |
| − | </p></dd><dd class="info">Type: integer</dd><dd class="info">Default: 0</dd><dt><span dir="ltr" lang="en">maxage</span></dt><dd class="description"><p>Set the <code>max-age</code> HTTP cache control header to this many seconds. Errors are never cached.
| |
| − | </p></dd><dd class="info">Type: integer</dd><dd class="info">Default: 0</dd><dt><span dir="ltr" lang="en">assert</span></dt><dd class="description"><p>Verify that the user is logged in if set to <kbd>user</kbd>, <em>not</em> logged in if set to <kbd>anon</kbd>, or has the bot user right if <kbd>bot</kbd>.
| |
| − | </p></dd><dd class="info">One of the following values: anon, bot, user</dd><dt><span dir="ltr" lang="en">assertuser</span></dt><dd class="description"><p>Verify the current user is the named user.
| |
| − | </p></dd><dd class="info">Type: user, by user name</dd><dt><span dir="ltr" lang="en">requestid</span></dt><dd class="description"><p>Any value given here will be included in the response. May be used to distinguish requests.
| |
| − | </p></dd><dt><span dir="ltr" lang="en">servedby</span></dt><dd class="description"><p>Include the hostname that served the request in the results.
| |
| − | </p></dd><dd class="info">Type: boolean (<a href="#main.2Fdatatype.2Fboolean">details</a>)</dd><dt><span dir="ltr" lang="en">curtimestamp</span></dt><dd class="description"><p>Include the current timestamp in the result.
| |
| − | </p></dd><dd class="info">Type: boolean (<a href="#main.2Fdatatype.2Fboolean">details</a>)</dd><dt><span dir="ltr" lang="en">responselanginfo</span></dt><dd class="description"><p>Include the languages used for <var>uselang</var> and <var>errorlang</var> in the result.
| |
| − | </p></dd><dd class="info">Type: boolean (<a href="#main.2Fdatatype.2Fboolean">details</a>)</dd><dt><span dir="ltr" lang="en">origin</span></dt><dd class="description"><p>When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).
| |
| − | </p><p>For authenticated requests, this must match one of the origins in the <code>Origin</code> header exactly, so it has to be set to something like <kbd><a rel="nofollow" class="external free" href="https://en.wikipedia.org">https://en.wikipedia.org</a></kbd> or <kbd><a rel="nofollow" class="external free" href="https://meta.wikimedia.org">https://meta.wikimedia.org</a></kbd>. If this parameter does not match the <code>Origin</code> header, a 403 response will be returned. If this parameter matches the <code>Origin</code> header and the origin is whitelisted, the <code>Access-Control-Allow-Origin</code> and <code>Access-Control-Allow-Credentials</code> headers will be set.
| |
| − | </p><p>For non-authenticated requests, specify the value <kbd>*</kbd>. This will cause the <code>Access-Control-Allow-Origin</code> header to be set, but <code>Access-Control-Allow-Credentials</code> will be <code>false</code> and all user-specific data will be restricted.
| |
| − | </p></dd><dt><span dir="ltr" lang="en">uselang</span></dt><dd class="description"><p>Language to use for message translations. <kbd><a href="/api.php?action=help&modules=query%2Bsiteinfo">action=query&meta=siteinfo</a></kbd> with <kbd>siprop=languages</kbd> returns a list of language codes, or specify <kbd>user</kbd> to use the current user's language preference, or specify <kbd>content</kbd> to use this wiki's content language.
| |
| − | </p></dd><dd class="info">Default: user</dd><dt><span dir="ltr" lang="en">errorformat</span></dt><dd class="description"><p>Format to use for warning and error text output.
| |
| − | </p>
| |
| − | <dl><dt>plaintext</dt>
| |
| − | <dd>Wikitext with HTML tags removed and entities replaced.</dd>
| |
| − | <dt>wikitext</dt>
| |
| − | <dd>Unparsed wikitext.</dd>
| |
| − | <dt>html</dt>
| |
| − | <dd>HTML.</dd>
| |
| − | <dt>raw</dt>
| |
| − | <dd>Message key and parameters.</dd>
| |
| − | <dt>none</dt>
| |
| − | <dd>No text output, only the error codes.</dd>
| |
| − | <dt>bc</dt>
| |
| − | <dd>Format used prior to MediaWiki 1.29. <var>errorlang</var> and <var>errorsuselocal</var> are ignored.</dd></dl></dd><dd class="info">One of the following values: bc, html, none, plaintext, raw, wikitext</dd><dd class="info">Default: bc</dd><dt><span dir="ltr" lang="en">errorlang</span></dt><dd class="description"><p>Language to use for warnings and errors. <kbd><a href="/api.php?action=help&modules=query%2Bsiteinfo">action=query&meta=siteinfo</a></kbd> with <kbd>siprop=languages</kbd> returns a list of language codes, or specify <kbd>content</kbd> to use this wiki's content language, or specify <kbd>uselang</kbd> to use the same value as the <var>uselang</var> parameter.
| |
| − | </p></dd><dd class="info">Default: uselang</dd><dt><span dir="ltr" lang="en">errorsuselocal</span></dt><dd class="description"><p>If given, error texts will use locally-customized messages from the MediaWiki namespace.
| |
| − | </p></dd><dd class="info">Type: boolean (<a href="#main.2Fdatatype.2Fboolean">details</a>)</dd></dl></div>
| |
| − | <div class="apihelp-block apihelp-examples"><div class="apihelp-block-head">Examples:</div><dl><dt>Help for the main module.</dt><dd><a href="/api.php?action=help" dir="ltr">api.php?action=help</a> <a href="/index.php/Special:ApiSandbox#action=help"><small>[open in sandbox]</small></a></dd><dt>All help in one page.</dt><dd><a href="/api.php?action=help&recursivesubmodules=1" dir="ltr">api.php?action=help&recursivesubmodules=1</a> <a href="/index.php/Special:ApiSandbox#action=help&recursivesubmodules=1"><small>[open in sandbox]</small></a></dd></dl></div>
| |
| − | <div class="apihelp-block apihelp-permissions"><div class="apihelp-block-head">Permissions:</div><dl><dt>writeapi</dt><dd>Use of the write API</dd><dd>Granted to: all, user and bot</dd><dt>apihighlimits</dt><dd>Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.</dd><dd>Granted to: bot and sysop</dd></dl></div>
| |
| − |
| |
| − | <h3 class="apihelp-header"><span id="main/datatypes"></span><span class="mw-headline" id="main.2Fdatatypes">Data types</span></h3><p>Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as <a href="/api.php?action=help&modules=edit">edits</a> with MD5 checks) to fail.
| |
| − | </p><p>Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. <kbd>param=value1|value2</kbd> or <kbd>param=value1%7Cvalue2</kbd>. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator <i>and</i> prefix the value with U+001F, e.g. <kbd>param=%1Fvalue1%1Fvalue2</kbd>.
| |
| − | </p><p>Some parameter types in API requests need further explanation:
| |
| − | </p><dl><dt id="main/datatype/boolean"><span id="main.2Fdatatype.2Fboolean"></span>boolean</dt><dd><p>Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
| |
| − | </p></dd><dt id="main/datatype/expiry"><span id="main.2Fdatatype.2Fexpiry"></span>expiry</dt><dd><p>Expiry values be relative (e.g. <kbd>5 months</kbd> or <kbd>2 weeks</kbd>) or absolute (e.g. <kbd>2014-09-18T12:34:56Z</kbd>). For no expiry, use <kbd>infinite</kbd>, <kbd>indefinite</kbd>, <kbd>infinity</kbd> or <kbd>never</kbd>.
| |
| − | </p></dd><dt id="main/datatype/timestamp"><span id="main.2Fdatatype.2Ftimestamp"></span>timestamp</dt><dd><p>Timestamps may be specified in several formats, see <a href="http://www.mediawiki.org/wiki/Special:MyLanguage/Timestamp" class="extiw" title="mw:Special:MyLanguage/Timestamp">the Timestamp library input formats documented on mediawiki.org</a> for details. ISO 8601 date and time is recommended: <kbd><var>2001</var>-<var>01</var>-<var>15</var>T<var>14</var>:<var>56</var>:<var>00</var>Z</kbd>. Additionally, the string <kbd>now</kbd> may be used to specify the current timestamp.
| |
| − | </p></dd></dl><h3 class="apihelp-header"><span id="main/templatedparams"></span><span class="mw-headline" id="main.2Ftemplatedparams">Templated parameters</span></h3><p>Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter <var>fruits</var> to specify which fruits are being requested and a templated parameter <var>{fruit}-quantity</var> to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like <kbd>fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20</kbd>.
| |
| − | </p>
| |
| − | <h3 class="apihelp-header"><span id="main/credits"></span><span class="mw-headline" id="main.2Fcredits">Credits</span></h3><p>API developers:
| |
| − | </p>
| |
| − | <ul><li>Yuri Astrakhan (creator, lead developer Sep 2006–Sep 2007)</li>
| |
| − | <li>Roan Kattouw (lead developer Sep 2007–2009)</li>
| |
| − | <li>Victor Vasiliev</li>
| |
| − | <li>Bryan Tong Minh</li>
| |
| − | <li>Sam Reed</li>
| |
| − | <li>Brad Jorsch (lead developer 2013–present)</li></ul><p>Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org
| |
| − | or file a bug report at <a rel="nofollow" class="external free" href="https://phabricator.wikimedia.org/">https://phabricator.wikimedia.org/</a>.
| |
| − | </p>
| |
| − | <div class="printfooter">Retrieved from "<a dir="ltr" href="https://ccga.io/index.php/Special:ApiHelp">https://ccga.io/index.php/Special:ApiHelp</a>"</div></div>
| |
| − | </div>
| |
| − | </div>
| |
| − |
| |
| − | <script>(RLQ=window.RLQ||[]).push(function(){mw.config.set({"wgBackendResponseTime":989});});</script>
| |
| − | <div id="mw-html-debug-log"></div></body></html>
| |