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

(main | wbsgetsuggestions)

This module requires read rights.
Source: PropertySuggester
License: GPL-2.0-or-later

API module for getting suggestions of additional properties to add to a Wikibase entity. The API module is primarily intended for use by the suggester widget when users are editing Wikibase entities.

Parameters:

entity: Suggest properties for the given entity, based on existing list of properties that the entity has.
properties: Suggest additional properties for the given list of properties.; Separate values with | or alternative.; Maximum number of values is 50 (500 for clients allowed higher limits).
types: Suggest additional properties for the given list of types (these values are equal to ones that would be gathered through the classifyingPropertyIds if an entity is provided in the API call). Used in combination with the properties parameter.; Separate values with | or alternative.; Maximum number of values is 50 (500 for clients allowed higher limits).
limit: Maximum number of results.; Type: integer or max; The value must be between 0 and 50.; Default: 7
continue: Offset where to continue a search.; Type: integer
language: Language for result.; One of the following values: aa, ab, abs, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, agq, ak, aln, als, alt, am, ami, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, bag, ban, ban-bali, bar, bas, bat-smg, bax, bbc, bbc-latn, bbj, bcc, bci, bcl, be, be-tarask, be-x-old, bfd, bg, bgn, bh, bho, bi, bjn, bkc, bkh, bkm, blk, bm, bn, bo, bpy, bqi, bqz, br, brh, bs, btm, bto, bug, bxr, byv, ca, cak, cbk-zam, cdo, ce, ceb, ch, cho, chr, chy, ckb, cnh, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, dag, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dua, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, en-us, eo, es, es-419, es-formal, et, eto, etu, eu, ewo, ext, fa, fat, ff, fi, fit, fiu-vro, fj, fkv, fmp, fo, fon, fr, frc, frp, frr, fur, fy, ga, gaa, gag, gan, gan-hans, gan-hant, gcr, gd, gl, gld, glk, gn, gom, gom-deva, gom-latn, gor, got, gpe, grc, gsw, gu, guc, gur, guw, gv, gya, ha, hak, haw, he, hi, hif, hif-latn, hil, ho, hr, hrx, hsb, hsn, ht, hu, hu-formal, hy, hyw, hz, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, isu, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kcg, kea, ker, kg, khw, ki, kiu, kj, kjp, 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, ksf, ksh, ksw, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lem, lez, lfn, lg, li, lij, liv, lki, lld, lmo, ln, lns, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mad, mai, map-bms, mcn, mcp, mdf, mg, mh, mhr, mi, min, mk, ml, mn, mni, mnw, mo, mos, mr, mrh, mrj, ms, ms-arab, mt, mua, mus, mwl, my, myv, mzn, na, nah, nan, nan-hani, nap, nb, nds, nds-nl, ne, new, ng, nge, nia, niu, nl, nl-informal, nla, nmg, nmz, nn, nnh, nnz, no, nod, nov, nqo, nrm, nso, nv, ny, nyn, nys, oc, ojb, olo, om, or, os, osa-latn, ota, pa, pag, pam, pap, pap-aw, pcd, pcm, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, pwn, qu, quc, qug, rgn, rif, rm, rmc, rmf, rmy, rn, ro, roa-rup, roa-tara, rsk, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, rwr, ryu, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, se-fi, se-no, se-se, sei, ses, sg, sgs, sh, shi, shi-latn, shi-tfng, shn, shy, shy-latn, si, simple, sjd, sje, sju, sk, skr, skr-arab, sl, sli, sm, sma, smj, smn, sms, sn, so, sq, sr, sr-ec, sr-el, srn, sro, srq, ss, st, stq, sty, su, sv, sw, syl, szl, szy, ta, tay, tcy, tdd, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tly-cyrl, tn, to, tpi, tr, tru, trv, ts, tt, tt-cyrl, tt-latn, tum, tvu, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, uz-cyrl, uz-latn, ve, vec, vep, vi, vls, vmf, vmw, vo, vot, vro, vut, wa, war, wes, wls, wo, wuu, wya, xal, xh, xmf, xsy, yas, yat, yav, ybb, yi, yo, yrl, 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; Default: en
context: Either item, reference or qualifier.; One of the following values: item, qualifier, reference; Default: item
include: Which suggestions to include: Per default only properties that might be added (non-deprecated, not yet present) will be suggested.; One of the following values: Can be empty, or all; Default: (empty)
search: Search for this text.; Default: (empty)
event: Event ID used to match events recorded client and server side.; Default: (empty)

Examples:

Get suggestions for entity Q4: api.php?action=wbsgetsuggestions&entity=Q4 [open in sandbox]
Get suggestions for entity Q4 from rank 10 to 15: api.php?action=wbsgetsuggestions&entity=Q4&continue=10&limit=5 [open in sandbox]
Get suggestions for the property combination P21 and P31: api.php?action=wbsgetsuggestions&properties=P31|P21 [open in sandbox]
Get suggestions for the qualifiers that are used with P21: api.php?action=wbsgetsuggestions&properties=P21&context=qualifier [open in sandbox]
Get suggestions for the references that are used with P21: api.php?action=wbsgetsuggestions&properties=P21&context=reference [open in sandbox]