From Knowledge Center
1. Choose web service
Available web services:
Help
With this special page you are able to create the #ws-syntax for calling a web service from a Wiki article. Choose one of the available web services in the dropdown-menu above.
2. Define parameters
| Alias: | Use: | Value: | Use default value: |
|---|
Help
The table displays the included parameters of the web service. Required parameters are activated by default. If you like to use a parameter when calling the web service, activate the Use checkbox and provide a value for that parameter. Some parameters provide default values. If you like to use a default value instead of providing your own value, then activate the Use default value checkbox. If this fields are greyed out, there are no values available.
The system creates automatically some special parameters for Linked Data sources, which you can use when calling such a web service. The use of those parameters is optional. The url-suffix can be used to specify the URL of the Linked Data source. The value of that parameter will be appended to the URL, which you have defined in the Wiki Web Service Definition. If you did not defined a URL in the WWSD, define the complete URL of the Linked Data source via that parameter.
A Linked Data source can contain triples for several subjects. Specify the subject, in which you are interested, via the subject parameter. Note that you can use namespace prefixes, which you have defined in the WWSD. If you don’t provide a value for this parameter, all subjects will be considered.
The table displays the included parameters of the web service. Required parameters are activated by default. If you like to use a parameter when calling the web service, activate the Use checkbox and provide a value for that parameter. The system creates automatically some special parameters for Linked Data sources, which you can use when calling such a web service. The use of those parameters is optional. The url-suffix can be used to specify the URL of the Linked Data source. The value of that parameter will be appended to the URL, which you have defined in the Wiki Web Service Definition. If you did not defined a URL in the WWSD, define the complete URL of the Linked Data source via that parameter. A Linked Data source can contain triples for several subjects. Specify the subject, in which you are interested, via the subject parameter. Note that you can use namespace prefixes, which you have defined in the WWSD. If you don’t provide a value for this parameter, all subjects will be considered. Use the properties parameter to specify the properties, which you wish to output, but for which you did not have defined a result part in your WWSD. Use a unique alias and a URI therefore, e.g. Artist=http://example.org/artist; alias2=propertyURI2;.... Note that you can use only namespace prefixes, which you have defined in the WWSD. Use the language parameter if you are only interested in literals in a certain language, e.g. en for literals in English.
3. Choose result parts
| Alias: | Use: | Label |
|---|
Help
Activate the Use checkboxes of each result part you like to display in your Wiki article.
The system automatically creates special purpose result parts for Linked Data: allSubjects, allProperties and allObjects. The allSubjects result part will display all subjects, for which triples are returned by the Linked Data source. The allProperties will display all properties and allObjects all objects.
4. Choose output format
Format:
Sort: By: Order:
Template:
Limit: Offset:
Help
Choose in the dropdown-list which format you like to use for displaying the web service result in your Wiki article. Some formats need also to specify a template which will be used for formatting the rows of the result. You will find an overview of all templates at the page [[Special:Templates]].
6. Result
Help
In the last step you have three possibilities. The Display preview-button shows a preview of the web service results. The Display #ws-syntax-button displays the #ws-syntax which was created by the GUI. The Copy to clipboard-button copies the #ws-syntax to local clipboard. If you navigated to this GUI from the semantic toolbar while you were editing an article, then you can directly go back and the #ws-syntax will be automatically added into the editor.
