Wikibase/API/ru

Общее вступление
API Wikibase предоставляется набором расширений, реализующих модули API MediaWiki. Так что чтобы использовать его, вам следует быть несколько осведомлёнными на тему сетевого API MediaWiki: действия, query-запросы, и так далее, и, наоборот, ваши знания об общих параметрах, таких как,   и других, применимы к API Wikibase.

Изменения API Wikibase производятся согласно Политике стабильности интерфейса.

Wikibase и Викиданные
Wikibase предоставляет общий механизм хранения утверждений в виде структурированных данных. Любая вики на MediaWiki может запустить его.

(См. wikidata:Glossary для объяснения этих терминов.) На кластере Викимедиа, большинство вики не выполняют весь набор расширений Wikibase. Утверждения о пунктах находятся на сервере. Так как это включает утверждения о миллионах объектов из Википедий, по этому ресурсу неплохо бывает выполнить поиск!

(Склад Викимедиа обладает собственным Wikibase для свойств файлов на Складе.)

Расширения реализуют подмодули and the API modules Чтобы сгенерировать документацию API только для одного из этих модулей, после Special:ApiHelp следует добавить, например, перейдите по странице Special:ApiHelp/wbgetentities.
 * pageterms query property submodule
 * wikibase query meta submodule0
 * wbavailablebadges
 * wbcreateclaim
 * wbcreateredirect
 * wbeditentity
 * wbformatvalue
 * wbgetclaims
 * wbgetentities
 * wblinktitles
 * wbmergeitems
 * wbparsevalue
 * wbremoveclaims
 * wbremovequalifiers
 * wbremovereferences
 * wbsearchentities
 * wbsetaliases
 * wbsetclaim
 * wbsetclaimvalue
 * wbsetdescription
 * wbsetlabel
 * wbsetqualifier
 * wbsetreference
 * wbsetsitelink
 * wbsgetsuggestions

Чтобы сгенерировать документацию API по нескольким модулям на одной странице, передайте разделённые символом  названия модулей в параметре   в запросе  ; например, |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 этот URL генерирует документацию по всем вышеперечисленным модулям.

Клиенты Wikibase
Многие вики Викимедиа (но,, не ) работают с установленным расширением Wikibase Client. Это расширение позволяет клиентам API:
 * делать запросы к метаинформационному подмодулю,, чтобы определять URL полного хранилища данных Wikibase см. справку API по этому подмодулю
 * делать запросы к подмодулю определения свойств,, чтобы получать информацию с Викиданных о страницах на текущей вики

POST и GET

 * Запросы, изменяющие содержимое, должны использовать токен.
 * Запросам следует использовать HTTP POST или GET в зависимости от модуля API. Модули, изменяющие содержимое, используют метод POST. Используйте POST, чтобы избегать проблем при подключении через плохо работающие прокси.
 * Клиенты должны знать об ошибках при работе с API и обрабатывать полученные сообщения о них.

Параметры модулей
Некоторые параметры доступны практически всегда. Формы множественного числа используются в случаях, когда параметр может принимать список из нескольких значений. Обычно у возвращаемого значения или есть ключ, содержащий приведённое к целому булево значение, или ключ  , содержащий два (необязательно — три) ключа  ,   и. Этот последний ключ ассоциирован с дополнительной информацией. Информация о действии или передаётся на верхнем уровне, или в ключе item (для единичных объектов) или items (для множественных). Если объектов несколько, каждый находится под ключом, равным своему идентификаторы. См. также разделы Успешное выполнение и Ошибки.
 * id | ids : Идентифицирует объект entity или объекты entities, самый типичный объект item. Форма множественного числа доступна в wbgetentities. Списки идентификаторов следует разделять символом.
 * site ∩ title | sites ∩ titles : Определяет один объект или несколько объектов. Множественное число используется в wbgetentities. Одновременно только один из параметров sites и titles может принимать множественное число.
 * language | languages : Указанный язык используется для фильтрации меток и описаний в действиях, получающих данные, или для определения конкретного языка в действиях, задающих данные.
 * format : Допустимые значения — только json (или jsonfm для отладки) и xml (или xmlfm для отладки), другие форматы не поддерживаются.
 * summary : Добавляет указанное пользователем описание действия вместо описания, генерируемого системой. Если параметр не указан, модуль сгенерирует своё описание, а если это невозможно, описание будет предоставлено самим объектом.
 * token : Зашифрованная строка, которую должен передать делающий запрос, чтобы запрос был выполнен.
 * baserevid : Идентификатор последней известной версии, который должен быть передан, чтобы сервер мог обнаруживать конфликты правок.


 * Обратите внимание, что пустые объекты возвращаются как массивы JSON, а не как объекты JSON.
 * Обратите внимание, что при указании пустых параметров содержимое самого свойства объекта удаляется.

wbgetentities
Module to get the content of several entities, possibly with only parts of the entity included. Entities that are checked for existence, but not found, are reported (bugzilla:45509). During lookup both sites and titles can be a list, that is if the entities are items, 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. getEntities( ( ids XOR ( sites, titles ) ), *props, *languages )
 * ids are numeric identifiers for existing entities, if an entity does not exist they will be marked as missing.
 * sites ∩ titles is pairs that identifies multiple existing entities (only items), if they do not exist they will be marked as missing.
 * props which list to report, possibly filtered by language if they are language specific. Possible values are info, labels, descriptions, sitelinks, claims, datatype, aliases, separated with |. Note that sitelinks are not language specific.
 * sort
 * dir
 * languages are one or more languages to filter the list against. If it is missing all valid languages are reported.
 * languagefallback Apply language fallback for languages defined in the "languages" parameter
 * normalize Try to normalize the page title against the client site (This only works if exactly one site and one page have been given)
 * ungroupedlist Do not group snaks by property id


 * Examples


 * Request
 * Result


 * Request
 * Result

wbeditentity

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


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


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

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

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.
 * 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
Module for getting Wikibase claims.


 * entity is Id of the entity from which to obtain claims.
 * property is optional parameter to include the specified property. Currently the only recognized value is references.
 * claim a GUID identifying the claim. Required unless entity is provided.
 * rank is optional filter to return only the claims that have the specified rank. (deprecated, normal, preferred)
 * props which list to report, possibly filtered by language if they are language specific. Note that sitelinks are not language specific.


 * Examples


 * Request
 * Result

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
 * 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
Модуль для поиска запрашиваемой информации.


 * search — искомая текстовая строка
 * language — язык поиска
 * type — тип возвращаемых объектов
 * limit — максимальное количество возвращаемых результатов (по умолчанию 7)
 * continue — смещение, с которого начинать запрос после предыдущего поиска


 * Примеры


 * Запрос
 * Результат


 * Запрос
 * Результат


 * Запрос
 * Результат

wblinktitles
Модуль, ассоциирующий две статьи на двух разных вики с одним объектом Wikibase.


 * tosite ∩ totitle — пара, определяющая ссылку на первую статью
 * fromsite ∩ fromtitle — пара, определяющая ссылку на вторую статью


 * Примеры


 * Запрос
 * Результат

wbmergeitems
Модуль, объединяющий две записи в Wikibase.
 * fromid — числовой идентификатор записи, из которой объединяются данные
 * toid — числовой идентификатор записи, в которую объединяются данные
 * ignoreconflicts — массив элементов записи, конфликты для которых игнорируются. Может содержать только значения label и/или description и/или sitelink.


 * Примеры


 * Запрос
 * Результат

wbparsevalue
Модуль, выполняющий синтаксический разбор строк с использованием серверного обработчика ValueParser.


 * parser
 * values
 * options


 * Примеры


 * Запрос
 * Результат

wbformatvalue
Модуль для форматирования значений данных (DataValues).
 * generate
 * datavalue
 * datatype
 * options


 * Примеры


 * Запрос
 * Результат

wbentityusage
Модуль как свойство (prop) в, чтобы включить данные по использованию объекту в результат.
 * Примеры


 * Запрос
 * Результат

wbcheckconstraints
Модуль, проверяющий данные утверждения или объекты на соответствие заданным условиям.


 * id Идентификатор(ы) объекта/объектов (записей, свойств, …), которые вы хотите проверить. Будет проведена проверка всех утверждений для этих объектов. Возможно сочетание с claimid для проверки каких-либо отдельных утверждений для других объектов.
 * claimid Идентификатор(ы) отдельных утверждений, которые вы хотите проверить. Может сочетаться с параметром id, но перечисленные в этом параметре утверждения могут не принадлежать идентификаторам, перечисленным в id.
 * constraintid Если параметр указан, проверяются только приведённые утверждения (если не указан, проверяются все). Идентификатор ограничения — это идентификатор соответствующего утверждения для свойства, для которого это ограничение определено.

Формат вывода действия wbcheckconstraints основан на формате Wikibase JSON, но везде, где формат Wikibase JSON может содержать snak, ответ запроса к wbcheckconstraints вместо этого содержит объект с членами  и. — это хэш соответствующего snak, а  — список отчётов по отдельным ограничениям для этого snak.

В структуру вывода встроены результаты отчётов об отдельных ограничениях, представленные объектами со следующими членами:
 * : Основной статус результата. Основные статусы —,   и   (нарушение необязательного ограничения). Другие статусы —   (сущность является исключением из ограничения),   (нереализованное или неизвестное ограничение),   (параметры определения ограничения содержат ошибки) и   (проверка ограничена пропущена для утверждения, отмеченного как устаревшее). API ещё находится в активной разработке, и новые статусы могут быть добавлены без преждевременного объявления.
 * : Идентификатор свойства, соответствующий свойству проверяемого snak, и это то же свойство, на котором определено ограничение.
 * : Объект со следующими членами:
 * : Идентификатор ограничения, то есть идентификатор утверждения, определяющего ограничение.
 * : Тип ограничения, представленный идентификатором записи.
 * : Переведённая на язык пользователя метка записи, идентификатор которой указан в.
 * : Ссылка на страницу справки по типу ограничения.


 * : Удобное для восприятия сообщение, объясняющее результат (обычно в случае нарушения), в формате HTML.
 * : Идентификатор проверяемого утверждения, если результат принадлежит основному snak утверждения. Этот член отсутствует в результатах проверок спецификаторов, ссылок, и других snak, которые не являются основными snak сохранённых утверждений.
 * : Если этот необязательный член присутствует и содержит сводящееся к булевой истине значение, это означает, что результат был кэширован. Это значение может быть объектом с членом, которое показывает, насколько (в секундах) могло устареть значение.
 * Примеры


 * Запрос
 * Результат

Время

 * Модель календаря
 * Q1985727 - григорианский календарь
 * Q1985786 - юлианский календарь

Токен
Для совершения правок требуется токен редактирования. Этот токен может быть получен через query&meta=tokens, или через устаревшие действие action=tokens. См. также Manual:Edit token.

Версия
API использует идентификаторы версий для обнаружения конфликтов редактирования. Если идентификатор версии известен из предыдущего ответа, загрузки страницы или какого-либо похожего события, передайте версию редактированию. Без идентификатора версии невозможно с высокой точностью обнаруживать конфликты редактирования. Если конфликт редактирования уже обнаружен, запрашивающий должен получить идентификатор более новой версии, чтобы получить возможность продолжить. Для этого обычно запрашивается wbgetentities для соответствующей записи, а из ответа считывается (и используется) идентификатор версии.

Ошибки
Возможные для всех модулей ошибки могут быть найдены по адресу, например wbeditentity

«Ожидаемые» ошибки будут иметь стандартизованную форму: Для сообщений error информация servedby передаётся безусловно, но при некоторых менее критических ошибках может отсутствовать. В некоторых случаях сообщения error могут быть вставлены в конец success под названием warning(s).
 * пример :

Все сообщения об ошибках в модулях Wikibase должны быть интернационализованы (i18n) и локализованы (l10n), но важно отметить, что сообщения об ошибках, исходящих из основы API, могут не быть локализованы. Язык текущего вошедшего в учётную запись пользователя (обычно такой же, как и в веб-интерфейсе) будет использоваться по умолчанию в сообщениях об ошибках. Это поведение можно переопределить, указав  в URL-строке запроса.

Не проверяйте значение info на соответствие какой-либо конкретной ошибке, вместо этого используйте значение code, так как оно независимо от локализации.

Интернационализованное сообщение об ошибке, которое не локализовано, как оно должно быть, будет заключено в дополнительные угловые скобки. Если сообщение об ошибке правильно локализовано, угловые скобки будут убраны, и информационная строка будет выведена прямым текстам. Если предположить, что пользователь вошёл в учётную запись и использует английский язык, будет выведено что-то наподобие следующего: Переключение на норвежский язык в Special:Preferences или дописывание в URL  изменит текст строки «info» на локализованный вариант, в то время как строка «code» останется неизменной. Большое количество сообщений об ошибках не локализованы должным образом.
 * пример :

Успех
Может быть удалён, так как все обычные вызовы вернут какого-либо рода данные, если не возникло ошибочное состояние.

Если достигнут «успех», у него будет следующая форма, когда

Интерпретация значения «успеха» может зависеть от непосредственных параметров вызова, но обычно это булево значение, приведённое к целочисленному типу. Его смысл — то, что все предыдущие проверки имели результат true. Если число равно нулю, какие-либо дополнительные значения могут быть неправильными.

В структуре после успешного вызова могут быть дополнительные значения.

См. также

 * API:Main page
 * Руководство:Параметр maxlag
 * API:Межсайтовые запросы