Wikibase/API/es

Introducción general
La API de Wikibase es proporcionada por un conjunto de extensiones que implementan módulos API de MediaWiki. Así que, para usarlo, deberás estar familiarizado con la API de acciones de MediaWiki: acciones, consultas, etc., y a su vez toda la experiencia que puedas tener con parámetros genéricos tales como  y , etc. también es válida para la API de Wikibase.

Los cambios en la API de Wikibase están sujetos a la política de interfaz estable.

Wikibase y Wikidata
Wikibase proporciona un mecanismo general para almacenar declaraciones como datos estructurados. Cualquier instalación de MediaWiki puede ejecutarlo.

(Véase Wikidata:Glosario para una explicación de estos términos.) En el clúster de Wikimedia, la mayoría de los wikis no ejecutan el conjunto completo de extensiones de Wikibase. Las declaraciones sobre elementos viven en el servidor. Dado que esto incluye declaraciones sobre los millones de elementos en Wikipedias, ¡es un recurso fantástico para consultar!

(Wikimedia Commons tiene su propia Wikibase para las propiedades de los archivos en Commons.)

Las extensiones implementan el  de submódulos and the API modules Para generar la documentación de uno solo de estos módulos, anexa  a Special:ApiHelp; por ejemplo, visita Special:ApiHelp/wbgetentities.
 * pageterms query property submodule
 * wikibase query meta submodule
 * wbcontentlanguages query meta submodule - (docs)
 * wbavailablebadges
 * wbcreateclaim
 * wbcreateredirect
 * wbeditentity
 * wbformatvalue
 * wbgetclaims
 * wbgetentities
 * wblinktitles
 * wbmergeitems
 * wbparsevalue
 * wbremoveclaims
 * wbremovequalifiers
 * wbremovereferences
 * wbsearchentities
 * wbsetaliases
 * wbsetclaim
 * wbsetclaimvalue
 * wbsetdescription
 * wbsetlabel
 * wbsetqualifier
 * wbsetreference
 * wbsetsitelink
 * wbsgetsuggestions

Para generar la documentación de varios módulos en una sola página, pasa los nombres de los módulos, separados por, como el parámetro   en  ; por ejemplo, |query+wikibase|wbavailablebadges|wbcreateclaim|wbcreateredirect|wbeditentity|wbformatvalue|wbgetclaims|wbgetentities|wblinktitles|wbmergeitems|wbparsevalue|wbremoveclaims|wbremovequalifiers|wbremovereferences|wbsearchentities|wbsetaliases|wbsetclaim|wbsetclaimvalue|wbsetdescription|wbsetlabel|wbsetqualifier|wbsetreference|wbsetsitelink|wbsgetsuggestions esta URL genera la documentación de todos los módulos enumerados anteriormente.

Clientes Wikibase
Muchos wikis de Wikimedia incorporan la extensión Cliente Wikibase. Esto permite a los clientes de la API instalados en ellos
 * consultar el submódulo meta  para determinar las URL para el repositorio de Wikibase ver la página de ayuda de la API
 * consultar el submódulo de propiedades  para obtener información de Wikidata sobre páginas del wiki local

Post o get

 * Requests that change content should use a token.
 * Requests should use HTTP POST or GET requests according to api module. Modules that change content use POST. Use POST to avoid problem with non-behaving proxies.
 * Clients should be aware of and handle errors from the API.

Parámetros de módulos
Algunos parámetros están casi siempre disponibles. Las formas plurales se utilizan en los casos en que un parámetro puede tomar varios valores. Normalmente el valor de retorno tiene, o bien una clave  con un booleano convertido a entero, o bien una clave   con un objeto formato por dos o a veces tres claves, ,   y. La última es información adicional. La información sobre la acción se pasa en el nivel superior o en item si es un solo elemento o en items si son varios. Si son varios elementos, cada uno se puede encontrar en una clave con su propio identificador de elemento. Véanse los párrafos Éxito y Errores.
 * id | ids : Identifica una entidad o unas entidades específicas, generalmente un elemento. La forma plural se utiliza en wbgetentities. Las listas de identificadores deberían usar  como separador.
 * site ∩ title | sites ∩ titles : Identifica uno o varios elementos. La forma plural se usa en wbgetentities. Solo se permite que o bien sites o bien titles tenga valores múltiples, pero no ambos.
 * language | languages : El idioma se usa como mecanismo de filtro para filtrar etiquetas y descripciones en acciones de lectura o para identificar un idioma específico en acciones de escritura.
 * format : Debe estar siempre en json (o jsonfm para depuración) o xml (o xmlfm para depuración). No se admiten otros formatos.
 * summary : Añade un resumen personalizado además de generado por el sistema.
 * token : Una cadena cifrada que el solicitante debe enviar en caso de que se cumplimente la petición.
 * baserevid : Un identificador para la última revisión conocida que se debe enviar para que el servidor pueda detectar conflictos de edición.


 * Ten en cuenta que los objetos vacíos se devuelven como arrays json y no como objetos.
 * Ten en cuenta que los parámetros vacíos eliminan la entrada del elemento.

wbgetentities
Please see the live docs and try the examples in the API Sandbox.

wbeditentity
live docs


 * 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.
 * data
 * clear is a marker to clear out the complete item and start from scratch.
 * new


 * Examples


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Request

or


 * Result


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Request

or


 * Result

wbsetlabel
Module to set a label for a single Wikibase entity. See live docs.


 * 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.
 * language is the language for the label. The language must be a valid identifier.
 * value is the value of the label

Set the label of the item "Q42" to the English language string "Wikimedia":

Set the label of the item with sitelink "enwiki → Earth" to the English language string "Planet Earth"

wbsetdescription
Module to set a description for a single Wikibase entity. See live docs.


 * 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.
 * language is the language for the description. The language must be a valid identifier.
 * value is the value of the description.


 * Set the string "An encyclopedia that everyone can edit" for page with id "Q42" as a description in English language:
 * Set the string "An encyclopedia that everyone can edit" as a description in English language for page with a sitelink to enwiki:Wikipedia:

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. See live docs. 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.
 * 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.
 * language


 * Examples


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result

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.
 * 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.
 * badges is the list of badges linked to the given sitelink.


 * Examples


 * Request
 * Result


 * Request
 * Result

wbgetclaims
Please see the live docs and try the examples in the API Sandbox.

wbcreateclaim

 * entity is the id of the entity you are adding the claim to.
 * snaktype (value, novalue, somevalue)
 * property is the id of the snaks property.
 * value of snak when creating a claim with a snak that has a value.
 * Examples


 * Request
 * Result


 * Request
 * Result


 * Request
 * Result


 * Note: value parameters "globe" and "precision" are optional. Default for "globe" is "http://www.wikidata.org/entity/Q2" (earth).


 * Request
 * Result


 * Request
 * Result

wbsetclaim
Module for creating or updating an entire Claim.


 * claim a claim in json form
 * index


 * Example


 * Request
 * Result

wbsetclaimvalue
Module for setting the value of a Wikibase claim.


 * claim a GUID identifying the claim. Required.
 * snaktype (value, novalue, somevalue).
 * value of snak when setting a claim with a snak that has a value in JSON format.


 * Example


 * Request
 * Result

wbremoveclaims
Module for removing Wikibase claims.


 * claim a GUID identifying the claim.


 * Example


 * Request
 * Result

wbsetqualifier
Module for creating a qualifier or setting the value of an existing one.


 * claim a GUID identifying the claim. Required.
 * property Id of the snaks property
 * value Object value in JSON format.
 * snaktype
 * snakhash


 * Examples

In this example, p4 is a string property
 * Request
 * Result


 * Request
 * Result


 * Request
 * Result

wbremovequalifiers
Module for removing a qualifier from a claim.


 * claim a GUID identifying the claim. Required.
 * qualifiers a hash of the qualifier that should be removed.


 * Examples


 * Request
 * Result

wbsetreference
Module for creating a reference or setting the value of an existing one.


 * statement a GUID identifying the statement. Required.
 * snaks
 * snaks-order
 * reference a hash of the reference that should be updated.
 * index


 * Examples


 * Request
 * Result


 * Request
 * Result

wbremovereferences
Module for removing one or more references of the same statement.


 * statement a GUID identifying the statement. Required.
 * references a hash of the reference that should be updated.


 * Example


 * Request
 * Result

wbsearchentities
Módulo para buscar entidades.


 * search es la cadena de texto que se busca
 * language es el idioma en el que se hace la búsqueda
 * type es el tipo de entidades que devolver
 * limit es el número máximo de resultados que devolver (por defecto son 7)
 * continue desplazamiento, para proseguir una consulta previa


 * Ejemplos


 * Petición
 * Resultado


 * Petición
 * Resultado


 * Petición
 * Resultado

wblinktitles
Módulo para asociar dos artículos de dos wikis diferentes con un elemento Wikibase.


 * tosite ∩ totitle es el par que identifica el primer enlace de sitio
 * fromsite ∩ fromtitle es el par que identifica el segundo enlace de sitio


 * Ejemplos


 * Petición
 * Resultado

wbmergeitems
Module to merge two Wikibase items.
 * fromid is the numeric identifier for the item to merge from
 * toid is the numeric identifier for the item to merge to
 * ignoreconflicts Array of elements of the item to ignore conflicts for, can only contain values of "label" and or "description" and or "sitelink"


 * Ejemplos


 * Petición
 * Resultado

wbparsevalue
Módulo para analizar gramaticalmente los strings usando un backend ValueParser.


 * parser
 * values
 * options


 * Ejemplos


 * Petición
 * Resultado

wbformatvalue
Módulo para formatear DataValues.
 * generate: The desired output format to generate. One of the following values:,  ,  . Default:.
 * 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:,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,  ,.
 * property: This can (and should) be used instead of datatype to indicate the property ID for this value. For instance, in the case of an external-id with a formatter URL, the value will be formatted with the appropriate link.
 * options: This takes a JSON object containing various options to customize the rendering. The lang field can always be supplied, with a Wikimedia language code (for instance to determine how month names will be rendered for dates). The list of options supported by each datatype is not centralized yet but can be guessed from here: https://github.com/search?utf8=%E2%9C%93&q=%22OPT%22+user%3Awmde+user%3ADataValues+extension%3Aphp&type=Code


 * Ejemplos


 * Petición
 * Resultado

wbentityusage
Module as a prop in  to add entity usage data to the result.
 * Ejemplos


 * Petición
 * Resultado

wbcheckconstraints
Módulo para comprobar restricciones para reclamaciones o entidades dadas.


 * id Identificador(es) de entidad correspondientes a las entidades (elementos, propiedades, …) que deseas verificar. Se verificarán todas las declaraciones de las entidades. Se puede combinar con claimid para verificar algunas declaraciones individuales de otras entidades.
 * claimid Identificador(es) de declaración correspondientes a las declaraciones individuales que deseas verificar. Se puede combinar con id, pero las declaraciones enumeradas aquí no tienen por qué pertenecer a los identificadores enumerados allá.
 * constraintid Si están especificadas, se verificarán solo esas restricciones (en caso contrario, se verificarán todas). El identificador de una restricción es el identificador de declaración de la declaración correspondiente de la propiedad en la que se define esa restricción.
 * status Devolver solo resultados de verificación con estos estados. Solo las peticiones que limitan los estados a  se benefician del almacenamiento en caché. (Este también es el valor predeterminado.)

El formato de salida de la acción wbcheckconstraints se basa en el formato JSON de Wikibase, pero en cualquier lugar donde el formato JSON de Wikibase pudiera contener un snak, la respuesta wbcheckconstraints contiene en su lugar un objeto con los atributos  y. es el hash del snak correspondiente, y  es una lista de los informes de restricciones individuales de ese snak.

Incluidos en la estructura de la salida hay resultados de informes de restricciones individuales, que son objetos con los siguientes componentes:
 * : El estado principal del resultado. Los estados principales son,   y   (violación de restricción no obligatoria). Otros estados son   (la entidad es una excepción para la restricción),   (restricción no implementada o desconocida),   (los parámetros de la definición de la restricción están rotos) y   (la comprobación de la restricción se ignoró por declaración obsoleta). A medida que la API sigue evolucionando, se podrán añadir estados nuevos sin aviso.
 * : La propiedad ID de la propiedad del snak siendo comprobada, la cual también es la propiedad en la que se define la restricción.
 * : Un objeto con los miembros siguientes:
 * : El identificador de la restricción, que es el identificador de declaración correspondiente a la declaración de restricción que define la restricción.
 * : El tipo de restricción, que es un identificador de elemento.
 * : La etiqueta del elemento con el identificador dado en, en el idioma del usuario.
 * : Un enlace a una página de ayuda para el tipo de restricción.


 * : Un mensaje inteligible para humanos que explica el resultado (principalmente en caso de una vulneración), en formato HTML.
 * : El identificador de declaración que se está verificando, en caso de que el resultado pertenezca al snak principal de una declaración. Este miembro está ausente en resultados de verificación para calificadores, referencias y cualquier otro snak que no sea el snak principal de declaraciones guardadas.
 * : If this optional member is present and contains a truthy value, the result was cached. El valor puede ser un objeto con un componente, que indica lo desactualizado que puede estar el valor, en segundos.
 * Ejemplos


 * Solicitudes
 * Resultado

Tiempo

 * Modelo de calendario
 * Q1985727 - Calendario gregoriano
 * Q1985786 - Calendario juliano

Token
An Edit token is required to make edits. This token can be obtained through query&meta=tokens, or by the deprecated. Véase también.

Revisión
La API utiliza identificadores de revisión para detectar conflictos de ediciones. Si se conoce el identificador de revisión de una respuesta, carga de página o acción similar anterior en el tiempo, entonces pasa el identificador a la edición. Sin el identificador, no es posible detectar conflictos de ediciones con fiabilidad. En caso de conflicto de ediciones, el solicitante debe obtener un identificador de revisión más reciente para poder continuar. Esto suele conllevar la necesidad de pedir wbgetentities para el elemento en cuestión y luego almacenar (y usar) la revisión de la entrada.

Errores
Se pueden encontrar errores posibles para todos los módulos en, por ejemplo, wbeditentity

Los errores «esperados» tendrán un formato estandarizado: El servedby está incluido incondicionalmente en mensajes error, pero puede estar ausente de errores que no sean fatales. En algunos casos, mensajes error pueden estar anexados a un success y denominarse warning(s).
 * ejemplo :

Todos los mensajes de error de los módulos de Wikibase deberían estar internationalizados (i18n) y localizados (l10n), pero ten en cuenta que los mensajes de error del sistema base de la API pueden no estar localizados. El idioma que tenga definido el usuario conectado (generalmente el mismo que en la interfaz web) será el predeterminado para mensajes de error. Sin embargo, puedes especificar otro idioma añadiendo  a la cadena de la consulta en la URL

No pruebes a utilizar el valor de info para un determinado error, en lugar de ello usa el valor de code porque será independiente de la localización.

Un mensaje de error internacionalizado que no esté localizado como debería estará rodeado por un par de cuñas. Si el mensaje de error está correctamente localizado, las cuñas desaparecerán y se mostrará la cadena en texto plano. Suponiendo que el usuario esté conectado y use como idioma el inglés, se mostrará más o menos como sigue. Al cambiar al noruego en las Especial:Preferencias o al añadir  a la URL, cambiará el texto de la cadena info a una variante localizada, aunque la cadena code permanezca constante. Muchos mensajes de error no están correctamente localizados.
 * ejemplo :

Éxito
Se puede eliminar, ya que todas las llamadas normales devolverán algún tipo de datos a menos que haya una condición de error.

Si se consigue un éxito (success), tendrá la siguiente forma cuando

La interpretación del valor para success podrá depender de los parámetros de la llamada, pero normalmente es un booleano que está convertido a entero. Su significado es que todos los tests anteriores se han evaluado como verdaderos. Si el número es 0 (cero) cualquier otro valor adicional puede ser incorrecto.

Puede haber valores adicionales en la estructura después de una llamada exitosa.

Véase también

 * API:Página principal
 * Manual:Parámetro maxlag
 * API:Peticiones en sitios cruzados