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=wbsetreference

(main | wbsetreference)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: WikibaseClient
  • License: GPL-2.0-or-later

Creates a reference or sets the value of an existing one.

Specific parameters:
Other general parameters are available.
statement

A GUID identifying the statement for which a reference is being set

This parameter is required.
snaks

The snaks to set the reference to. JSON object with property IDs pointing to arrays containing the snaks for that property

This parameter is required.
snaks-order

The order of the snaks. JSON array of property ID strings

reference

A hash of the reference that should be updated. Optional. When not provided, a new reference is created

index

The index within the statement's list of references where to move the reference to. Optional. When not provided, an existing reference will stay in place while a new reference will be appended.

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.

tags

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.
baserevid

The numeric identifier for the revision to base the modification on. This is used for detecting conflicts during save.

Type: integer
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)