Wikibase/API

Historical versions API1, API2, API3, API4.

Work in progress!!

Wikibase API for the repo part, that is the part running on the central database with its database. There is a separate API for the clients, or in Wikidata lingo the attached wiki sites. There can be browsers connected to both the repo and the clients.

Requests to the repo API that changes content should use token, be aware of rights, use POST or GET requests according to mode (use POST to avoid problem with non-behaving proxies), and be aware of and handle errors from the API. In the examples below the requests are shown as GET, but that will only work when debugging is turned on.

Modules
There are some parameters that is always available, and some that are nearly always available. Plural forms are used in those cases where a parameter can take several values.


 * id | ids : Identifies a specific item or items. Plural form is used in wbgetitems.
 * site ∩ title | sites ∩ titles : Identifies a single item or multiple items. Plural form is used in wbgetitems. Only one of sites and titles can have multiple values at the same time.
 * language | languages : The language is used as a filter mechanism to filter labels and descriptions in get actions or to identify a specific language for set actions.
 * format : Should always be set to json (or jsonfm for debugging), or xml (or xmlfm for debugging), no other form is supported.
 * usekeys | nousekeys : Add keys (or do not add them) to some structures, if some formats are used, and will be silently ignored for other formats. Specifically it will be used for the json, yaml and raw formats. One of usekeys and nousekeys will be enabled according to whats defined in the default config and possibly LocalSettings.php.
 * summary : Adds a user specified summary instead of the system generated one. If not provided the module will generate its own summary, and if this fails the item itself will provide a summary.
 * token : An encrypted string the requester must pass on shall the request be fullfilled.
 * revision : An id for the last known revision that must be passed on shall the server be able to detect edit collisions.

Normally the return value either has a success key with a boolean cast as an integer or an error key with an object of two, optionally three, keys code, info and "*". The last one is additional information. Information about the action is either passed on the top level or under item if its one single item or items if its several. If it is several items each is found under a key with its own item id.


 * Note that empty objects are returned as json arrays and not as objects.
 * Note that the parameters item and link is not supported anymore.
 * Note that empty parameters removes the actual entry from the item.
 * Note that attribute in wbsetlanguageattribute is not supported anymore.

wbgetitems
Module to get the content of several items, possibly with only parts of the item included. Items that are checked for existens, but not found, are reported. During lookup both sites and titles can be a list, but the shorter one is cycled to match the longer one. If one of the lists contain a single entry it will be used for all entries from the other list. If both lists are equally long the sitelinks will be well-formed pairs. getItems( ( ids XOR ( sites, titles ) ), *props, *languages )
 * ids are numeric identifiers for existing items, if the items does not exist they will be marked as missing.
 * sites ∩ titles is pairs that identifies multiple existing items, if the items does not exist they will be marked as missing.
 * props which list to report, possibly filtered by language if they are language specific. Note that sitelinks are not language specific.
 * languages are one or more languages to filter the list against. If it is missing all valid languages are reported.
 * summary is a user entered string that is used in addition to an autocomment generated by the module itself.

{ 	"items": { "42": { 			"id": 42, "revision": 31186, "timestamp": "20120716140702", "sitelinks": { "enwiki": { "site": "enwiki", "title": "Death Star" }, 			}, 			"descriptions": { "en": { "language": "en", "value": "Nice place for old men with rhesphiratorry prroblemsss" } 			}, 			"labels": { "en": { "language": "en", "value": "Death Star" }, 				"nn": { "language": "nn", "value": "Dødsstjerna" } 			} 		} 	}, 	"success": 1 }
 * Example of general lookup with id : http://localhost/repo/api.php?action=wbgetitems&ids=42&format=jsonfm

{ 	"items": { "42": { 			"id": 42, "revision": 31186, "timestamp": "20120716140702", "labels": { "nn": { "language": "nn", "value": "Dødsstjerna" } 			} 		} 	}, 	"success": 1 }
 * Example of limited lookup with site-title pair: http://localhost/repo/api.php?action=wbgetitems&sites=enwiki&titles=Death_Star&props=labels&languages=nn&format=jsonfm

wbsetsitelink
Module to define new links to pages at external client sites. During processing of requests the module will query the external site to verify the existence of the page and to acquire the canonical form of the prefix and the pagename. linkSite( ( id XOR ( site, title ) ) OR baserevid, linksite, linktitle, *summary )
 * id is the numeric identifier for an existing item, if the item does not exist an error is returned.
 * site ∩ title is a pair that identifies a single existing item, if the item does not exist an error is returned.
 * baserevid is the page revision to use for further processing. Will be used for lookup of the item if id or site and title fails.
 * linksite is the site id for a client site that will be the target of the new link. The site will be queried during the call.
 * linktitle is the title of the page at the client site that will be the target of the new link. The site will be queried during the call.
 * summary is a user entered string that is used in addition to an autocomment generated by the module itself.

{ 	"item": { "sitelinks": { "nowiki": { "site": "nowiki", "title": "Bar" } 		}, 		"id": 42, "lastrevid": 31186 }, 	"success": 1 }
 * Example with use of site-title pair : http://localhost/repo/api.php?action=wbsetsitelink&site=nowiki&title=Foo&linksite=nowiki&linktitle=Bar&format=jsonfm

{ 	"item": { "sitelinks": { "nowiki": { "site": "nowiki", "title": "Foo" } 		}, 		"id": 42, "lastrevid": 31187 }, 	"success": 1 }
 * Example with use of id : http://localhost/repo/api.php?action=wbsetsitelink&id=42&linksite=nowiki&linktitle=Foo&format=jsonfm

wbsetlanguageattribute
Module to set label and description for a specific language. The language must be an existing and maintained language, and the label and description will be normalized. setLanguageAttribute( ( id XOR ( site, title ) ) OR baserevid, ( language AND ( label OR description ) ), *summary )
 * id is the numeric identifier for an existing item, if the item does not exist an error is returned.
 * site ∩ title is a pair that identifies a single existing item, if the item does not exist an error is returned.
 * baserevid is the page revision to use for further processing. Will be used for lookup of the item if id or site and title fails.
 * label is the new value for the label in the given language. The string wil be normalized.
 * description is the new value for the description in the given language. The string wil be normalized.
 * language is the language for the label and description. The language must be a valid identifier.
 * summary is a user entered string that is used in addition to an autocomment generated by the module itself.

{ 	"item": { "labels": { "en": { "language": "en", "value": "Cyberdyne" } 		}, 		"id": 42, "lastrevid": 31186 }, 	"success": 1, }
 * Example changing label : http://localhost/repo/api.php?action=wbsetlanguageattribute&id=42&language=en&label=Cyberdyne&format=jsonfm

{ 	"item": { "descriptions": { "sv": { "language": "sv", "value": "Place where Alice lived for a short time" } 		}, 		"id": 2, "lastrevid": 31186 }, 	"success": 1 }
 * Example changing description : http://localhost/repo/api.php?action=wbsetlanguageattribute&id=2&language=sv&description=Place%20where%20Alice%20lived%20for%20a%20short%20time&format=jsonfm

{ 	"item": { "labels": { "en": { "language": "en", "removed": "" } 		}, 		"id": 42, "lastrevid": 31186 }, 	"success": 1, }
 * Example removing label : http://localhost/repo/api.php?action=wbsetlanguageattribute&id=42&language=en&label=&format=jsonfm

wbsetaliases
Module to set, add and remove aliases from items. Aliases are alternate names for the items, that can be queried and used for lookup. setAliases( ( id XOR ( site, title ) ) OR baserevid, ( add OR remove ) XOR set, *summary )
 * id is the numeric identifier for an existing item, if the item does not exist an error is returned.
 * site ∩ title is a pair that identifies a single existing item, if the item does not exist an error is returned.
 * baserevid is the page revision to use for further processing. Will be used for lookup of the item if id or site and title fails.
 * set contains a list of strings that will be used as the new list of aliases. The values are normalized before they are used.
 * add contains a list of additional strings that will be used as aliases. The values are normalized before they are used.
 * remove contains a list of strings that will be removed from the the list of aliases. The values are normalized before they are used.
 * summary is a user entered string that is used in addition to an autocomment generated by the module itself.

{ 	"success": 1, "item": { "aliases": { "en": [ { 					"language": "en", "value": "Foo" }, 				{ 					"language": "en", "value": "Bar" } 			] 		}, 		"id": 42, "lastrevid": 31186 } }
 * Example set Foo and Bar : http://localhost/repo/api.php?action=wbsetaliases&language=en&id=5&set=Foo|Bar&format=jsonfm

{ 	"success": 1, "item": { "aliases": { "en": [ { 					"language": "en", "value": "Foo" }, 				{ 					"language": "en", "value": "Bar" }, 				{ 					"language": "en", "value": "Test" } 			] 		}, 		"id": 42, "lastrevid": 31186 } }
 * Example add Test : http://localhost/repo/api.php?action=wbsetaliases&language=en&id=5&add=Test&format=jsonfm

{ 	"success": 1, "item": { "aliases": { "en": [ { 					"language": "en", "value": "Bar" } 			] 		}, 		"id": 42, "lastrevid": 31186 } }
 * Example remove Foo and Test : http://localhost/repo/api.php?action=wbsetaliases&language=en&id=5&remove=Foo|Test&format=jsonfm

wbsetitem
''Note that this module is an interim solution to create and test items, and can change without further notice. The module itself can be removed in the final system. The solution is unsupported and any behavior is a feature or bug at the developers discretion. Especially note that the behavior of calls with empty or missing data can change. Also note that the only expected behavior is creation of new empty items.'' getItems( ( id XOR ( site, title ) ) OR baserevid, data, *clear, *summary )
 * id is the numeric identifier for an existing item, if the item does not exist an error is returned.
 * site ∩ title is a pair that identifies a single existing item, if the item does not exist an error is returned.
 * baserevid is the page revision to use for further processing. Will be used for lookup of the item if id or site and title fails.
 * clear is a marker to clear out the complete item and start from scratch.
 * summary is a user entered string that is used in addition to an autocomment generated by the module itself.
 * Example deletion of item [undocumented behavior]: http://localhost/repo/api.php?action=wbsetitem&id=42&data=&format=jsonfm
 * Empty an existing item, a minimum item is not defined, but it is likely that an item that is "empty" will be deleted during later processing.


 * Example creation of empty object : http://localhost/repo/api.php?action=wbsetitem&data={}&format=jsonfm
 * Builds an "empty" item if not given an id, a minimum item is not defined, but it is likely that an item that is "empty" will be deleted during later processing.

{ 	"item": { "id": 42, "lastrevid": 31186, }, 	"success": 1 }


 * Example creates a prefilled item [undocumented behavior]: http://localhost/repo/api.php?action=wbsetitem&data={%22labels%22:{%22de%22:%22Kopenhagen%22,%22en%22:%22Copenhagen%22}}&format=jsonfm
 * Builds an item with a few labels set, then returns the structure.

{ 	"item": { "id": 42, "lastrevid": 31186, "labels": { "de": { "language": "de", "value": "Kopenhagen" }, 			"en": { "language": "en", "value": "Copenhagen" } 		} 	}, 	"success": 1 }


 * Example modifies an existing item [undocumented behavior]: http://localhost/repo/api.php?action=wbsetitem&id=42&data={%22sitelinks%22:{%22nowiki%22:%22København%22,%22svwiki%22:%22Köpenhamn%22}}&format=jsonfm
 * Extends an item with a few sitelinks set, then returns the new structure.

{ 	"item": { "id": 42, "lastrevid": 31186, "labels": { "de": { "language": "de", "value": "Kopenhagen" }, 			"en": { "language": "en", "value": "Copenhagen" } 		}, 		"sitelinks": { "de": { "language": "nowiki", "value": "København" }, 			"en": { "language": "svwiki", "value": "Köpenhamn" } 		} 	}, 	"success": 1 } Note that setting sitelinks through this module bypasses normalization and verification. It is the sole responsibility of the user to do normalization and verification of the links before they are used.

New long format

 * This is examples of the new long format. This is closer to the internal representation and includes additional operations.

To make it easier to reuse information from other calls the structure in the request is (will be) made closer to the reply. Simple method-like requests will still be available as specific actions like wbsetlabel, wbsetdescription, wbsetaliases and wbsetsitelink. The changes are basically a shift from key-value pairs where the value is a single string, to a composite value that is an array. This will then contain the different parts and also possibly special actions. That complex structure is repeated for each value. Each of the repeated structures must also be according to the key if there is one, but it can be dismissed and the structures embedded in an array.

http://localhost/repo/api.php?action=wbsetitem&id=1&data={"labels":{"en":{"language":"en","value":"Foo"}},"descriptions":{"en":{"language":"en","value":"This%20is%20a%20text"}}}&format=jsonfm { 	"item": { "labels": { "en": { "language": "en", "value": "Foo" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		} 		"id": 2, "lastrevid": 6065 } } http://localhost/repo/api.php?action=wbsetitem&id=1&data={"labels":{"no":{"language":"no","value":"Bar","add":""}}}&format=jsonfm { 	"item": { "labels": { "en": { "language": "en", "value": "Foo" } 			"no": { "language": "no", "value": "Bar" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		} 		"id": 1, "lastrevid": 6065 } } http://localhost/repo/api.php?action=wbsetitem&id=1&data={"labels":{"en":{"language":"en","value":""}}}&format=jsonfm http://localhost/repo/api.php?action=wbsetitem&id=1&data={"labels":{"en":{"language":"en","value":"Foo","remove":""}}}&format=jsonfm { 	"item": { "labels": { "no": { "language": "no", "value": "Bar" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		} 		"id": 1, "lastrevid": 6065 } } http://localhost/repo/api.php?action=wbsetitem&id=1&data={"aliases":{"en":{"language":"en","values":["A","B","C"],"add":""}}}&format=jsonfm { 	"item": { "labels": { "no": { "language": "no", "value": "Bar" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		}, 		"aliases": { "en": [ { 					"language": "en", "value": "A" }, 				{ 					"language": "en", "value": "B" }, 				{ 					"language": "en", "value": "C" } 			] 		}, 		"id": 1, "lastrevid": 6065 } } http://localhost/repo/api.php?action=wbsetitem&id=1&data={"aliases":{"en":{"language":"en","values":["B"],"remove":""}}}&format=jsonfm { 	"item": { "labels": { "no": { "language": "no", "value": "Bar" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		}, 		"aliases": { "en": [ { 					"language": "en", "value": "A" }, 				{ 					"language": "en", "value": "C" } 			] 		}, 		"id": 1, "lastrevid": 6065 } } http://localhost/repo/api.php?action=wbsetitem&id=1&data={"sitelinks":{"enwiki":{"site":"enwiki","page":"Berlin","add":""}}}&format=jsonfm
 * Define a simple item
 * Add a label
 * Remove a label : The value of the removed item is neglected if the "remove" flag is set
 * Add aliases : The aliases are a list, but are still single values
 * Remove aliases
 * Add sitelinks

{ 	"item": { "labels": { "no": { "language": "no", "value": "Bar" } 		}, 		"descriptions": { "en": { "language": "en", "value": "This is a text" } 		}, 		"aliases": { "en": [ { 					"language": "en", "value": "A" }, 				{ 					"language": "en", "value": "C" } 			] 		},		"sitelinks": { "enwiki": { "site": "enwiki", "title": "Berlin" }		}, 		"id": 1, "lastrevid": 6065 } }

wbsearchbyname (partly)
This call is only partly implemented as it is not clear how the search should be done. searchByName( language, fragment, *hints )

Deprecated
A number of modules are deprecated and will be removed.

wbgetsitelinks [deprecated]
Note this module is not supported anymore, use wbgetitems with props set to sitelinks.

wbdeletelanguageattribute [deprecated]
Note this module is not supported anymore, use wbsetlanguageattribute with empty label or description.

wblinksite [deprecated]
Note this module is now called wbsetsitelink, and the link parameter is not supported anymore.

wbgetitemid [deprecated]
Note this module is not supported anymore, use wbgetitems with an empty props.

Token
All call to content changing API functions should be developed for (and prepared to) use the token. That includes Wikidata items and other associated pages. For the moment only one token is in use. Such tokens must be acquired before any operations that needs them are accessed or the operation will fail. If any operation returns a new token it should be used for all following request. Do not assume that the itemtoken is the same as the edittoken.

If the API is in debug mode, that is by setting apiInDebug to true, the use of tokens will be disabled. It is reenabled by setting apiDebugWithTokens to true. A production environment should not disable use of tokens.

New tokens are in ver. 0.1 acquired by a request to any of the modules deriving from \Wikibase\Api.php, with gettoken in the URL.

{ 	"wbsetitem": { "itemtoken": "a462a54d500848fa53a808fc26478dd4+\\" } }
 * Example using wbsetitem: http://localhost/repo/api.php?action=wbsetitem&gettoken&format=jsonfm

The current implementation is implemented as a API only solution, and the mw.user.tokens list is not populated with additional elements. See also subsection tokens in default modules.

Note that as default the API will require POST requests.

The API should use salted tokens, possibly for each item, and update it for each expensive call so serialization is enforced.

See also Manual:Edit token.

Revision
The API uses revision ids for edit collision detection. If the revision id is known from an previous reply, page load or similar, then pass on the revision to the edit. Without the revision id it is not possible to detect edit collisions in a reliable way. If there is an edit collision the requester must acquire a newer revision id to be able to continue. This typically involves requesting wbgetitems for the item in question, and then storing (and using) the revision from the entry.

Rights
All call to content changing API functions should be developed for (and prepared to) use rights. That includes errors due to insufficient access rights. That imply that it could be necessary to be logged in before content can be changed. The basic access rights write rights is in addition to the permissions.

If the API is in debug mode, that is by setting apiInDebug to true, the use of rights will be disabled. It is reenabled by setting apiDebugWithRights to true. A production environment should not disable use of rights.

Rights are named as "props-operation" and added to a group wbeditor. This could be reorganized into other groups or be divided as more fine grained rights or reorganized in other ways. The module name is shortened to make them more manageable.

In the current setup there are no read rights and there are also no default write rights for anonymous users. It seems likely that a setup for Wikipedia will assign 'update rights to anonymous users.

Note that with the default setup it is necessary to log in to the site, either through the usual web interface for the site or through global login (SUL).

Setup
$wgGroupPermissions['*']['item-override']		= true; $wgGroupPermissions['*']['item-create']			= true; $wgGroupPermissions['*']['item-remove']			= true; $wgGroupPermissions['*']['alias-add']			= true; $wgGroupPermissions['*']['alias-set']			= true; $wgGroupPermissions['*']['alias-remove']		= true; $wgGroupPermissions['*']['sitelink-remove']		= true; $wgGroupPermissions['*']['sitelink-update']		= true; $wgGroupPermissions['*']['label-remove']		= true; $wgGroupPermissions['*']['label-update']		= true; $wgGroupPermissions['*']['description-remove']		= true; $wgGroupPermissions['*']['description-update']		= true;
 * Default setup

$wgGroupPermissions['*']['item-override']			= true; $wgGroupPermissions['autoconfirmed']['item-create']	= true; $wgGroupPermissions['wbeditor']['item-remove']		= true; $wgGroupPermissions['*']['alias-add']			= true; $wgGroupPermissions['wbeditor']['alias-set']		= true; $wgGroupPermissions['*']['alias-remove']		= true; $wgGroupPermissions['wbeditor']['sitelink-remove']	= true; $wgGroupPermissions['*']['sitelink-update']		= true; $wgGroupPermissions['wbeditor']['label-remove']		= true; $wgGroupPermissions['*']['label-update']		= true; $wgGroupPermissions['wbeditor']['description-remove']	= true; $wgGroupPermissions['*']['description-update']		= true;
 * Alternate setup

Mode
All call to content changing API functions should be developed for (and prepared to) use the POST mode. During development it is possible to allow use of GET to make it simpler to piece together working requests. Javascript code for the browser should always use POST requests. By enabled the setting apiInDebug, that is to set it to true, the enforced use of POST is turned off.

If the API is in debug mode, that is by setting apiInDebug to true, all GET requests will be accepted. The rejection of GET requests are reenabled by setting apiDebugWithPost to true. A production environment could allow use of GET requests, but note that GET requests could create problems with caching.

Setup

 * apiInTest : Turns test mode on. Default is undefined. (Not in Use)
 * apiInDebug : Turns debug mode on. Default is undefined.
 * apiInDebugWithRights : Enforce use of rights during debug. Has no effect when apiInDebug is not set. Default is true.
 * apiInDebugWithPost : Enforce use of POST requests during debug. Has no effect when apiInDebug is not set. Default is true.
 * apiInDebugWithRights : Enforce use of rights during debug. Has no effect when apiInDebug is not set. Default is true.

Errors
If the error condition is prepared and expected, and a format is defined, the error messages will have a standardized form.

{ 	"servedby": "srv273", "error": { "code": "unknown_action", "info": "Unrecognized value for parameter 'action': blah" } }
 * example : http://localhost/repo/api.php?action=blah&format=jsonfm

The servedby is given unconditionally for error messages, but could be missing for some less than fatal errors. In some cases error messages can be appended to a success and be called warning(s).

All error messages from the Wikibase modules should be internationalized (i18n) and localized (l10n), but note that error messages from the base API system will usually not be localized. The user language for the logged in user (usually the same as in the web interface) will be the default for error messages. This can be overridden by putting uselang in the URL.

Do not depend on the info string for testing, use the code as this will remain independent of localization.

An internationalized error message that isn't localized as it should will have additional angle brackets.

{ 	"error": { "code": "no-such-item", "info": "&lt;wikibase-api-no-such-item&gt;" } }
 * example : http://localhost/repo/api.php?action=wbgetitemid&title=ThisPageDoesNotExist&site=fi&format=jsonfm

With correctly localized error message the angle brackets will go away and the info string will print out in clear text. Assuming the user is logged in and use English language it will print as something like the following.

{ 	"error": { "code": "no-such-item", "info": "There are no such item to be found" } }

Switching to Norwegian in the Special:Preferences or by appending  it will change the text of the info string to a localized variant, while the code string remains constant.

{ 	"error": { "code": "no-such-item", "info": "Det finnes ingen slik item" } }

A lot of error messages are not properly localized.

Success
Can be removed since all normal calls will return data of some kind, unless there is an error condition.

If a success is achieved it will have the following form when the  is set ([//labs.wikimedia.org/w/api.php?action=wbgetitem&format=jsonfm labs], localhost)

{ 	"success": /* int */ }

The interpretation of the value for success can be dependent on the actual parameters in the call, but usually it is a boolean that is type casted to an integer. Its meaning is that every previous tests evaluated to true. If the number is 0 (zero) any additional values might be wrong.

There might be additional values in the structure after a successful call.