API module "smwbrowse"

From semantic-mediawiki.org
Jump to: navigation, search
smwbrowse
Allows to search for properties, categories and concepts
Keywords
API · API module · ask query · action smwbrowse · smwbrowse
Further Information
Provided by: Semantic MediaWiki
Added: 3.0.0
Removed: still available

The "smwbrowse" API module supports the search for properties, categories and concepts via action "smwbrowse" (?action=smwbrowse) against Semantic MediaWiki using the MediaWiki API and get results back serialized in one of the supported formats. This module is similar to API-module "browsebyproperty"Allows to fetch information about a property or a list of properties. It was introduced with Semantic MediaWiki 3.0.0Released on an unknown date and compatible with MW 1.27.0 - 1.30.x..1

The module supports two parameters:

  1. "browse": The object to be searched, either "property", "category" or "concept"
  2. "params": The query parameters provided in json-format
    1. primary selectors: "limit", "offset" and "search"
    2. special selectors: "description" "prefLabel" and "usageCount" (available if "property" was chosen as the value for the "browse" parameter)
NoteNote: Returned results are by default cached for one hour. This time span may be adapted via the "api.browse" option to configuration parameter $smwgCacheUsageSets how the caching behaviour or special pages related to Semantic MediaWiki is controlled.

Examples

property information
../api.php?action=smwbrowse&browse=property&params={ "limit": 10, "offset": 0, "search": "Date", "description": true, "prefLabel": true, "usageCount": true }
category information
../api.php?action=smwbrowse&browse=category&params={ "limit": 10, "offset": 0, "search": "Date" }
concept information
../api.php?action=smwbrowse&browse=concept&params={ "limit": 10, "offset": 0, "search": "Date" }

References

  1. ^  Semantic MediaWiki: GitHub pull request gh:smw:2696