MediaWiki API help - Wikidata (original) (raw)

This is an auto-generated MediaWiki API documentation page.

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

(main | wbformatvalue)

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

Formats DataValues.

Specific parameters:

generate

The desired output format to generate.

One of the following values: text/html, text/html; disposition=verbose, text/html; disposition=verbose-preview, text/plain, text/x-wiki

Default: text/x-wiki

datavalue

The data to format. This has to be the JSON serialization of a DataValue object.

This parameter is required.

datatype

The value's data type. This is distinct from the value's type

One of the following values: commonsMedia, entity-schema, external-id, geo-shape, globe-coordinate, math, monolingualtext, musical-notation, quantity, string, tabular-data, time, url, wikibase-form, wikibase-item, wikibase-lexeme, wikibase-property, wikibase-sense

property

Property ID the data value belongs to, should be used instead of the datatype parameter.

options

The options the formatter should use. Provided as a JSON object.

The supported options are:

lang

The language in which the value should be formatted (a MediaWiki language code).

applyRounding

Whether to apply rounding to the number. Can be a boolean (automatic / no rounding) or an integer (exponent of the last significant decimal digits). Only useful for quantity values.

applyUnit

Whether to include the unit in the output (a boolean). Only useful for quantity values.

showcalendar

Whether to show the calendar model. Can be a boolean (always / never show) or the string "auto" (automatically determine whether to show). Only useful for time values.