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
list=wblistentityusage (wbeu)
- This module requires read rights.
- This module can be used as a generator.
- Source: WikibaseClient
- License: GPL-2.0-or-later
Returns all pages that use the given entity IDs.
Specific parameters:
Other general parameters are available.
- wbeuprop
Properties to add to the result.
- url
- If enabled the url of the entity will be added to the result.
- Values (separate with | or alternative): url
- wbeuaspect
Only return entity IDs that used this aspect.
- S
- The entity's sitelinks are used
- L
- The entity's label is used
- D
- The entity's description is used
- T
- The title of the local page corresponding to the entity is used
- C
- Statements from the entity are used
- X
- All aspects of an entity are or may be used
- O
- Something else about the entity is used. This currently implies alias usage and explicit checks for entity existence.
- Values (separate with | or alternative): C, D, L, O, S, T, X
- wbeuentities
Entities that have been used.
- This parameter is required.
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients that are allowed higher limits).
- wbeulimit
How many entity usages to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
- wbeucontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
Examples:
- Get pages that use the entity Q2.
- api.php?action=query&list=wblistentityusage&wbeuentities=Q2 [open in sandbox]
- Get pages that use the entity Q2 with URL included.
- api.php?action=query&list=wblistentityusage&wbeuentities=Q2&wbeuprop=url [open in sandbox]
- Get pages that use the entity Q2 and the aspect was sitelink or statement.
- api.php?action=query&list=wblistentityusage&wbeuentities=Q2&wbeuaspect=S|O [open in sandbox]