MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

action=wbsetaliases

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

Sets the aliases for a Wikibase entity.

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 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:
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)
add

List of aliases to add (can be combined with remove)

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
remove

List of aliases to remove (can be combined with add)

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
set

A list of aliases that will replace the current list (cannot be combined with neither add nor remove)

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
language

The language for which to set the aliases

This parameter is required.
One of the following values: aa, ab, abs, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, als, am, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, ban, bar, bat-smg, bbc, bbc-latn, bcc, bcl, be, be-tarask, be-x-old, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, btm, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, cho, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, es-419, es-formal, et, eu, ext, fa, ff, fi, fit, fiu-vro, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gcr, gd, gl, glk, gn, gom, gom-deva, gom-latn, gor, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, ho, hr, hrx, hsb, ht, hu, hu-formal, hy, hyw, hz, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kg, khw, ki, kiu, kj, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, kr, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mh, mhr, mi, min, mk, ml, mn, mni, mnw, mo, mr, mrj, ms, mt, mus, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, ng, niu, nl, nl-informal, nn, no, nov, nrm, nso, nv, ny, nys, oc, olo, om, or, os, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qu, qug, rgn, rif, rm, rmy, rn, ro, roa-rup, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shi-latn, shi-tfng, shn, shy-latn, si, simple, sk, skr, skr-arab, sl, sli, sm, sma, sn, so, sq, sr, sr-ec, sr-el, srn, ss, st, stq, sty, su, sv, sw, szl, ta, tay, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tpi, tr, tru, ts, tt, tt-cyrl, tt-latn, tum, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, uz-cyrl, uz-latn, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, yi, yo, yue, za, zea, zgh, zh, zh-classical, zh-cn, zh-hans, zh-hant, zh-hk, zh-min-nan, zh-mo, zh-my, zh-sg, zh-tw, zh-yue, zu
Examples:
Set the English aliases for the entity with ID Q1 to Foo and Bar
api.php?action=wbsetaliases&language=en&id=Q1&set=Foo|Bar [open in sandbox]
Add Foo and Bar to the list of English aliases for the entity with ID Q1
api.php?action=wbsetaliases&language=en&id=Q1&add=Foo|Bar [open in sandbox]
Remove Foo and Bar from the list of English aliases for the entity with ID Q1
api.php?action=wbsetaliases&language=en&id=Q1&remove=Foo|Bar [open in sandbox]
Remove Foo from the list of English aliases for the entity with ID Q1 while adding Bar to it
api.php?action=wbsetaliases&language=en&id=Q1&remove=Foo&add=Bar [open in sandbox]