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

Specific parameters:

Other general parameters are available.

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:
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.
tags: Change tags to apply to the revision.; Values (separate with | or alternative): openrefine-3.5, openrefine-3.7
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)
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)
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 Q999999998: api.php?action=wbeditentity&clear=true&id=Q999999998&data={} [open in sandbox]
Clear all data from entity with ID Q999999998 and set a label for en: api.php?action=wbeditentity&clear=true&id=Q999999998&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=Q999999998&data={"labels":[{"language":"no","value":"Bar","add":""}]} [open in sandbox]
Removes a label: api.php?action=wbeditentity&id=Q999999998&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=Q999999998&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=Q999999998&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=Q999999998&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 provided GUIDs: api.php?action=wbeditentity&id=Q999999998&data={"claims":[{"id":"Q999999998$D8404CDA-25E4-4334-AF13-A3290BCD9C0F","remove":""},{"id":"Q999999998$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=Q999999998&data={"claims":[{"id":"Q999999998$GH678DSA-01PQ-28XC-HJ90-DDFD9990126X","mainsnak":{"snaktype":"value","property":"P56","datavalue":{"value":"ChangedString","type":"string"}},"type":"statement","rank":"normal"}]} [open in sandbox]