MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

action=wbeditentity

(main | wbeditentity)
  • 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 single new Wikibase entity and modifies it with serialised information.

Parameters:
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 to be created. It is not allowed to have this set when id is also set.

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: aawiki, abwiki, acewiki, adywiki, afwiki, afwikiquote, akwiki, alswiki, amwiki, amwikiquote, angwiki, angwikiquote, angwikisource, anwiki, arcwiki, arwiki, arwikinews, arwikiquote, arwikisource, arzwiki, astwiki, astwikiquote, aswiki, aswikisource, atjwiki, avwiki, aywiki, azbwiki, azwiki, azwikiquote, azwikisource, barwiki, bat_smgwiki, bawiki, bclwiki, be_x_oldwiki, bewiki, bewikiquote, bewikisource, bgwiki, bgwikinews, bgwikiquote, bgwikisource, bhwiki, biwiki, bjnwiki, bmwiki, bmwikiquote, bnwiki, bnwikisource, bnwikivoyage, bowiki, bpywiki, brwiki, brwikiquote, brwikisource, bswiki, bswikinews, bswikiquote, bswikisource, bugwiki, bxrwiki, cawiki, cawikinews, cawikiquote, cawikisource, cbk_zamwiki, cdowiki, cebwiki, cewiki, chowiki, chrwiki, chwiki, chywiki, ckbwiki, cowiki, cowikiquote, crhwiki, crwiki, crwikiquote, csbwiki, cswiki, cswikinews, cswikiquote, cswikisource, cuwiki, cvwiki, cywiki, cywikiquote, cywikisource, dawiki, dawikiquote, dawikisource, dewiki, dewikinews, dewikiquote, dewikisource, dewikivoyage, dinwiki, diqwiki, dsbwiki, dtywiki, dvwiki, dzwiki, eewiki, elwiki, elwikinews, elwikiquote, elwikisource, elwikivoyage, emlwiki, enwiki, enwikinews, enwikiquote, enwikisource, enwikivoyage, eowiki, eowikinews, eowikiquote, eowikisource, eswiki, eswikinews, eswikiquote, eswikisource, eswikivoyage, etwiki, etwikiquote, etwikisource, euwiki, euwikiquote, euwikisource, extwiki, fawiki, fawikinews, fawikiquote, fawikisource, fawikivoyage, ffwiki, fiu_vrowiki, fiwiki, fiwikinews, fiwikiquote, fiwikisource, fiwikivoyage, fjwiki, fowiki, fowikisource, frpwiki, frrwiki, frwiki, frwikinews, frwikiquote, frwikisource, frwikivoyage, furwiki, fywiki, gagwiki, ganwiki, gawiki, gawikiquote, gdwiki, glkwiki, glwiki, glwikiquote, glwikisource, gnwiki, gomwiki, gorwiki, gotwiki, guwiki, guwikiquote, guwikisource, gvwiki, hakwiki, hawiki, hawwiki, hewiki, hewikinews, hewikiquote, hewikisource, hewikivoyage, hifwiki, hiwiki, hiwikiquote, hiwikivoyage, howiki, hrwiki, hrwikiquote, hrwikisource, hsbwiki, htwiki, htwikisource, huwiki, huwikinews, huwikiquote, huwikisource, hywiki, hywikiquote, hywikisource, hzwiki, iawiki, idwiki, idwikiquote, idwikisource, iewiki, igwiki, iiwiki, ikwiki, ilowiki, inhwiki, iowiki, iswiki, iswikiquote, iswikisource, itwiki, itwikinews, itwikiquote, itwikisource, itwikivoyage, iuwiki, jamwiki, jawiki, jawikinews, jawikiquote, jawikisource, jbowiki, jvwiki, kaawiki, kabwiki, kawiki, kawikiquote, kbdwiki, kbpwiki, kgwiki, kiwiki, kjwiki, kkwiki, kkwikiquote, klwiki, kmwiki, knwiki, knwikiquote, knwikisource, koiwiki, kowiki, kowikinews, kowikiquote, kowikisource, krcwiki, krwiki, krwikiquote, kshwiki, kswiki, kswikiquote, kuwiki, kuwikiquote, kvwiki, kwwiki, kwwikiquote, kywiki, kywikiquote, ladwiki, lawiki, lawikiquote, lawikisource, lbewiki, lbwiki, lbwikiquote, lezwiki, lfnwiki, lgwiki, lijwiki, liwiki, liwikinews, liwikiquote, liwikisource, lmowiki, lnwiki, lowiki, lrcwiki, ltgwiki, ltwiki, ltwikiquote, ltwikisource, lvwiki, maiwiki, map_bmswiki, mdfwiki, mgwiki, mhrwiki, mhwiki, minwiki, miwiki, mkwiki, mkwikisource, mlwiki, mlwikiquote, mlwikisource, mnwiki, mrjwiki, mrwiki, mrwikiquote, mrwikisource, mswiki, mtwiki, muswiki, mwlwiki, myvwiki, mywiki, mznwiki, nahwiki, napwiki, nawiki, nawikiquote, nds_nlwiki, ndswiki, ndswikiquote, newiki, newwiki, ngwiki, nlwiki, nlwikinews, nlwikiquote, nlwikisource, nlwikivoyage, nnwiki, nnwikiquote, novwiki, nowiki, nowikinews, nowikiquote, nowikisource, nrmwiki, nsowiki, nvwiki, nywiki, ocwiki, olowiki, omwiki, orwiki, orwikisource, oswiki, pagwiki, pamwiki, papwiki, pawiki, pawikisource, pcdwiki, pdcwiki, pflwiki, pihwiki, piwiki, plwiki, plwikinews, plwikiquote, plwikisource, plwikivoyage, pmswiki, pmswikisource, pnbwiki, pntwiki, pswiki, pswikivoyage, ptwiki, ptwikinews, ptwikiquote, ptwikisource, ptwikivoyage, quwiki, quwikiquote, rmwiki, rmywiki, rnwiki, roa_rupwiki, roa_tarawiki, rowiki, rowikinews, rowikiquote, rowikisource, rowikivoyage, ruewiki, ruwiki, ruwikinews, ruwikiquote, ruwikisource, ruwikivoyage, rwwiki, sahwiki, sahwikiquote, sahwikisource, satwiki, sawiki, sawikiquote, sawikisource, scnwiki, scowiki, scwiki, sdwiki, sdwikinews, sewiki, sgwiki, shnwiki, shwiki, simplewiki, simplewikiquote, siwiki, skwiki, skwikiquote, skwikisource, slwiki, slwikiquote, slwikisource, smwiki, snwiki, sowiki, sqwiki, sqwikinews, sqwikiquote, srnwiki, srwiki, srwikinews, srwikiquote, srwikisource, sswiki, stqwiki, stwiki, suwiki, suwikiquote, svwiki, svwikinews, svwikiquote, svwikisource, svwikivoyage, swwiki, szlwiki, tawiki, tawikinews, tawikiquote, tawikisource, tcywiki, tetwiki, tewiki, tewikiquote, tewikisource, tgwiki, thwiki, thwikinews, thwikiquote, thwikisource, tiwiki, tkwiki, tkwikiquote, tlwiki, tnwiki, towiki, tpiwiki, trwiki, trwikinews, trwikiquote, trwikisource, tswiki, ttwiki, ttwikiquote, tumwiki, twwiki, tyvwiki, tywiki, udmwiki, ugwiki, ugwikiquote, ukwiki, ukwikinews, ukwikiquote, ukwikisource, ukwikivoyage, urwiki, urwikiquote, uzwiki, uzwikiquote, vecwiki, vecwikisource, vepwiki, vewiki, viwiki, viwikiquote, viwikisource, viwikivoyage, vlswiki, vowiki, vowikiquote, warwiki, wawiki, wowiki, wowikiquote, wuuwiki, xalwiki, xhwiki, xmfwiki, yiwiki, yiwikisource, yowiki, zawiki, zawikiquote, zeawiki, zh_classicalwiki, zh_min_nanwiki, zh_min_nanwikiquote, zh_min_nanwikisource, zh_yuewiki, zhwiki, zhwikinews, zhwikiquote, zhwikisource, zhwikivoyage, zuwiki, commonswiki, wikidatawiki
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.

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 "Bots".

Type: boolean (details)
data

The serialized object that is used as the data source. A newly created entity will be assigned an 'id'.

This parameter is required.
clear

If set, the complete entity is emptied before proceeding. The entity will not be saved before it is filled with the "data", possibly with parts excluded.

Type: boolean (details)
Examples:
Create a new empty item, return full entity structure
api.php?action=wbeditentity&new=item&data={} [open in sandbox]
Create a new item and set labels for de and en
api.php?action=wbeditentity&new=item&data={"labels":{"de":{"language":"de","value":"de-value"},"en":{"language":"en","value":"en-value"}}} [open in sandbox]
Create a new property containing the json data, return full entity structure
api.php?action=wbeditentity&new=property&data={"labels":{"en-gb":{"language":"en-gb","value":"Propertylabel"}},"descriptions":{"en-gb":{"language":"en-gb","value":"Propertydescription"}},"datatype":"string"} [open in sandbox]
Clear all data from entity with ID Q42
api.php?action=wbeditentity&clear=true&id=Q42&data={} [open in sandbox]
Clear all data from entity with ID Q42 and set a label for en
api.php?action=wbeditentity&clear=true&id=Q42&data={"labels":{"en":{"language":"en","value":"en-value"}}} [open in sandbox]
Adds a label without overwriting it if it already exists
api.php?action=wbeditentity&id=Q42&data={"labels":[{"language":"no","value":"Bar","add":""}]} [open in sandbox]
Removes a label
api.php?action=wbeditentity&id=Q42&data={"labels":[{"language":"en","value":"Foo","remove":""}]} [open in sandbox]
Sets sitelink for nowiki, overwriting it if it already exists
api.php?action=wbeditentity&id=Q42&data={"sitelinks":{"nowiki":{"site":"nowiki","title":"KĂžbenhavn"}}} [open in sandbox]
Sets description for nb, overwriting it if it already exists
api.php?action=wbeditentity&id=Q42&data={"descriptions":{"nb":{"language":"nb","value":"nb-Description-Here"}}} [open in sandbox]
Creates a new claim on the item for the property P56 and a value of "ExampleString"
api.php?action=wbeditentity&id=Q42&data={"claims":[{"mainsnak":{"snaktype":"value","property":"P56","datavalue":{"value":"ExampleString","type":"string"}},"type":"statement","rank":"normal"}]} [open in sandbox]
Removes the claims from the item with the GUIDs Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F and Q42$GH678DSA-01PQ-28XC-HJ90-DDFD9990126X
api.php?action=wbeditentity&id=Q42&data={"claims":[{"id":"Q42$D8404CDA-25E4-4334-AF13-A3290BCD9C0F","remove":""},{"id":"Q42$GH678DSA-01PQ-28XC-HJ90-DDFD9990126X","remove":""}]} [open in sandbox]
Sets the claim with the GUID to the value of the claim
api.php?action=wbeditentity&id=Q42&data={"claims":[{"id":"Q42$GH678DSA-01PQ-28XC-HJ90-DDFD9990126X","mainsnak":{"snaktype":"value","property":"P56","datavalue":{"value":"ChangedString","type":"string"}},"type":"statement","rank":"normal"}]} [open in sandbox]