Reconciliation API modules: recon-suggest-propvalue
From CODECS Dev
- Main
- Configuration
- Local file settings
- JSON profiles
- Modules
- recon
- recon-suggest-entity
- recon-suggest-entity (MW)
- recon-suggest-property
- recon-suggest-type
- recon-suggest-propvalue
- Other
- Additional usage guide
- Implementation notes
- Implementation notes: SMW
- Implementation notes: MW and types
- Redirect service
- TypeaheadSearch
- Future
Service for suggesting property values on the basis of the provided property name and substring. This service is not covered by the Reconciliation API specifications.
Parameters
Parameter name
Description
sourceCurrently supports
smw (Semantic MediaWiki) only.profileIs not currently configurable through a profile.
substrThe substring to autocomplete on.
substrpatternMatch pattern.
propertyThe property to retrieve values from.
offsetResult offset.
limitResult limit.
Development
- Does not currently support profiles.
Examples from CODECS
- https://codecs.vanhamel.nl/api.php?action=recon-suggest-propvalue&source=smw&property=Textplain&substr=Sea&format=json
- https://codecs.vanhamel.nl/api.php?action=recon-suggest-propvalue&source=smw&property=Display%20title%20of&substr=Mac
- https://codecs.vanhamel.nl/api.php?action=recon-suggest-propvalue&source=smw&property=Belongs%20to&substr=
Not intended for typeahead search but we can use it here to demonstrate the API:
Dev info. API: https://codecs.vanhamel.nl/api.php?action=recon-suggest-propvalue&origin=%2A&source=smw&property=Has+keyword&substr=
Target URL: https://codecs.vanhamel.nl/Show:Search?phrase=
Footer URL: https://dev.vanhamel.nl/index.php?title=Special:Search&fulltext=1&search=
Target URL: https://codecs.vanhamel.nl/Show:Search?phrase=
Footer URL: https://dev.vanhamel.nl/index.php?title=Special:Search&fulltext=1&search=
Notes
- At least For properties of data type 'Text',
idandnameare identical. For properties of data type 'Page', there may be an option in the future to work with labels such as display titles.
