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

action=smwbrowse

(main | smwbrowse)

This module requires read rights.
Source: Semantic MediaWiki
License: GPL-2.0-or-later

API module to support browse activities for different entity types in Semantic MediaWiki.

https://www.semantic-mediawiki.org/wiki/Help:API

Specific parameters:

Other general parameters are available.

browse: Specifies the type of browse activity; This parameter is required.; One of the following values: category, concept, page, property, psubject, pvalue, subject
params: JSON encoded parameters containing required and optional fields and depend on the selected browse type; This parameter is required.

Examples:

Example showing how to browse properties using a wildcard search and default pagination.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "*" } [open in sandbox]
Example showing how to browse properties with pagination and descending sort order.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 10, "search": "*", "sort": "desc" } [open in sandbox]
Example showing how to browse properties filtered by a search term.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date" } [open in sandbox]
Example showing how to browse properties and include property descriptions in the results.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true } [open in sandbox]
Example showing how to browse properties including descriptions and preferred labels.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true, "prefLabel": true } [open in sandbox]
Example showing how to browse properties including descriptions, preferred labels, and usage counts.: api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true, "prefLabel": true, "usageCount": true } [open in sandbox]
Example showing how to browse property values for a given property and search term.: api.php?action=smwbrowse&browse=pvalue&params={ "limit": 10, "offset": 0, "property" : "Foo", "search": "Bar" } [open in sandbox]
Example showing how to browse subjects for a property-value pair with a search filter.: api.php?action=smwbrowse&browse=psubject&params={ "limit": 10, "offset": 0, "property" : "Foo", "value" : "Bar", "search": "foo" } [open in sandbox]
Example showing how to browse categories with default pagination.: api.php?action=smwbrowse&browse=category&params={ "limit": 10, "offset": 0, "search": "" } [open in sandbox]
Example showing how to browse categories filtered by a search term.: api.php?action=smwbrowse&browse=category&params={ "limit": 10, "offset": 0, "search": "Date" } [open in sandbox]
Example showing how to browse concepts with default pagination.: api.php?action=smwbrowse&browse=concept&params={ "limit": 10, "offset": 0, "search": "" } [open in sandbox]
Example showing how to browse concepts filtered by a search term.: api.php?action=smwbrowse&browse=concept&params={ "limit": 10, "offset": 0, "search": "Date" } [open in sandbox]
Example showing how to browse pages with default pagination.: api.php?action=smwbrowse&browse=page&params={ "limit": 10, "offset": 0, "search": "Main" } [open in sandbox]
Example showing how to browse pages including full text and full URL output.: api.php?action=smwbrowse&browse=page&params={ "limit": 10, "offset": 0, "search": "Main", "fullText": true, "fullURL": true } [open in sandbox]
Example showing how to browse a specific subject page including namespace and subobject support.: api.php?action=smwbrowse&browse=subject&params={ "subject": "Main page", "ns" :0, "iw": "", "subobject": "" } [open in sandbox]