MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=wbsetsitelink
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: WikibaseRepository
- License: GPL-2.0-or-later
Associates a page on a wiki with a Wikibase item or removes an already made such association.
- id
The identifier for the entity, including the prefix. Use either id or site and title together.
- new
If set, a new entity will be created. Set this to the type of the entity you want to create.
- One of the following values: item, property
- site
An identifier for the site on which the page resides. Use together with title to make a complete sitelink.
- One of the following values: mardi, swmath
- title
Title of the page to associate. Use together with site to make a complete sitelink.
- baserevid
The numeric identifier for the revision to base the modification on. This is used for detecting conflicts during save.
- Type: integer
- summary
Summary for the edit. Will be prepended by an automatically generated comment. The length limit of the autocomment together with the summary is 260 characters. Be aware that everything above that limit will be cut off.
Change tags to apply to the revision.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- bot
Mark this edit as bot. This URL flag will only be respected if the user belongs to the group "bot".
- Type: boolean (details)
- returnto
Page title. If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to the given page, instead of the page that was edited.
- Type: page title
- Accepts non-existent pages.
- returntoquery
URL query parameters (with leading ?). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given query parameters.
- Default: (empty)
- returntoanchor
URL fragment (with leading #). If saving the edit created a temporary account, the API may respond with an URL that the client should visit to complete logging in. If this parameter is provided, the URL will redirect to a page with the given fragment.
- Default: (empty)
- linksite
The identifier of the site on which the page to link resides
- This parameter is required.
- One of the following values: mardi, swmath
- linktitle
The title of the page to link. If this parameter is an empty string or both linktitle and badges are not set, the link will be removed.
- badges
The IDs of items to be set as badges. They will replace the current ones. If this parameter is not set, the badges will not be changed
- Values (separate with | or alternative):
- Add a sitelink to the English page "Hydrogen" to the item with ID Q999999998, if the sitelink does not exist
- api.php?action=wbsetsitelink&id=Q999999998&linksite=enwiki&linktitle=Hydrogen [open in sandbox]
- Add a sitelink to the English page "Hydrogen" to the item with ID Q999999998, if the sitelink does not exist. Also appends "Loves Oxygen" to the edit summary.
- api.php?action=wbsetsitelink&id=Q999999998&linksite=enwiki&linktitle=Hydrogen&summary=Loves%20Oxygen [open in sandbox]
- Add a sitelink to the German page "Wasserstoff" to the item that is linked with the English page "Hydrogen", if the sitelink does not exist
- api.php?action=wbsetsitelink&site=enwiki&title=Hydrogen&linksite=dewiki&linktitle=Wasserstoff [open in sandbox]
- Remove the German sitelink from the item
- api.php?action=wbsetsitelink&site=enwiki&title=Hydrogen&linksite=dewiki [open in sandbox]
- Add a sitelink to the Polish page "Wodór" to the item that is linked with the English page "Hydrogen", with one badge pointing to the item with ID "Q149"
- api.php?action=wbsetsitelink&site=enwiki&title=Hydrogen&linksite=plwiki&linktitle=Wodór&badges=Q149 [open in sandbox]
- Change badges for the link to the Polish page from the item with ID Q999999998 to two badges pointing to the items with IDs "Q2" and "Q149" without providing the link title
- api.php?action=wbsetsitelink&id=Q999999998&linksite=plwiki&badges=Q2|Q149 [open in sandbox]
- Change the link to the Polish page from the item with ID Q999999998 without changing badges
- api.php?action=wbsetsitelink&id=Q999999998&linksite=plwiki&linktitle=Warszawa [open in sandbox]
- Change the link to the Polish page from the item with ID Q999999998 and remove all of its badges
- api.php?action=wbsetsitelink&id=Q999999998&linksite=plwiki&linktitle=Wodór&badges= [open in sandbox]