CINXE.COM
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN" "http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd"> <html itemscope="itemscope" class=" js flexbox canvas canvastext webgl no-touch geolocation postmessage no-websqldatabase indexeddb hashchange history draganddrop websockets rgba hsla multiplebgs backgroundsize borderimage borderradius boxshadow textshadow opacity cssanimations csscolumns cssgradients no-cssreflections csstransforms csstransforms3d csstransitions fontface generatedcontent video audio localstorage sessionstorage webworkers applicationcache svg inlinesvg smil svgclippaths " itemtype="http://schema.org/WebPage" itemid="" xmlns:n0="http://www.w3.org/2000/xmlns/" n0:og="http://ogp.me/ns#" n0:fb="http://ogp.me/ns/fb#" n0:xhv="http://www.w3.org/1999/xhtml/vocab#"> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <script src="/skin/wiki/js/modernizr.js"></script><script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', VERSION: 'stable', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script><script type="text/javascript" src="/skin/wiki/js/jquery-2.js"></script><script type="text/javascript" src="/skin/wiki/js/jquery-migrate-1.js"></script><script type="text/javascript" src="/skin/wiki/js/underscore.js"></script><script type="text/javascript" src="/skin/wiki/js/doctools.js"></script><script type="text/javascript" src="/skin/wiki/js/translations.js"></script><script type="text/javascript" src="/skin/wiki/js/readthedocs-doc-embed.js"></script><link rel="stylesheet" href="/skin/wiki/css/default.css" type="text/css" /> <link rel="stylesheet" href="/skin/wiki/css/sphinx_rtd_theme.css" type="text/css" /> <link rel="stylesheet" href="/skin/wiki/css/readthedocs-doc-embed.css" type="text/css" /> <link rel="stylesheet" href="/skin/wiki/css/opl-style-overrides.css" type="text/css" /> <style type="text/css"> #HD_ODS_BAR { display: none; } table.dialog_body { display: none; } </style><script type="text/turtle" id="API_Wiki"> ## Generic Description ## Schema.org Terms @prefix oplwebsrv: <http://www.openlinksw.com/ontology/webservices#> . @prefix schema: <http://schema.org/> . @prefix wdrs: <http://www.w3.org/2007/05/powder-s#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema> . <#this_ODSWikiModuleAPIDoc> a schema:CreativeWork ; schema:name "ODS_Wiki" ; schema:description "ODS Wiki" ; schema:mainEntity <#this_ODSWikiModuleAPI> ; schema:about <#this_ODSWikiModuleAPI> . <#this_ODSWikiModuleAPI> a schema:WebApplication ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:name "ODS_Wiki" ; schema:description "ODS Wiki" ; schema:potentialAction <#action_e72f6fa9c9ded1dde2b1de4401640245> , <#action_9e7a615dc6a7d7c51ba06e8a8f23a008> , <#action_429602fd7c998576f4d0479442ca2d22> , <#action_729cba6da6eef97dd52310600fa19380> , <#action_ded71b69f3cb2382c41de656b0e47dc5> , <#action_635b7b603cb0f0eb209b48d84314936c> , <#action_45d783d5b32cc296c593ca9a8d0bc35d> , <#action_cdde6197c8d59cebb8175bb1ac4762e2> , <#action_7b702067e20ab47a339c5516028609f5> , <#action_e9f39bdb106aa5fe5f90ef9b326b2a4d> , <#action_b29f785d6b93058262bdf3fe34ecf228> , <#action_15a5d8e3f66d971db4861d1d65ff6cf1> , <#action_deacc95f5b016e50fb5f932072088b13> , <#action_d77c206f66cda3441af285832fa261fc> , <#action_b861d5c5bc09cc685019f0a4c0cbdbfd> , <#action_50c6359a7bba57e4875535108bf64f42> , <#action_08e13b75c529088b4afb42c25c7de2f3> , <#action_5b209cdd34211ac5e8bd5cfdad0d2d5a> . <#action_e72f6fa9c9ded1dde2b1de4401640245> a schema:Action ; schema:name "wiki_comment_delete" ; schema:target <#action_wiki.comment.delete> . <#action_wiki.comment.delete> a schema:EntryPoint ; schema:name "EntryPoint - wiki_comment_delete" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.comment.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.comment.delete> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>comment_id</parametername> </parameternamelist> <parameterdescription> <p>The numerical id of the comment to delete.</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <simplesect kind=\"see\"><p><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga429602fd7c998576f4d0479442ca2d22\">wiki.comment.new</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.comment.delete?comment_id=5555&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 07:07:00 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Delete a comment. </p>" ; oplwebsrv:hasParameter <#action_wiki.comment.delete_#_comment_id> . <#action_wiki.comment.delete_#_comment_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment_id" ; schema:name "comment_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The numerical id of the comment to delete.</p>" . <#action_9e7a615dc6a7d7c51ba06e8a8f23a008> a schema:Action ; schema:name "wiki_comment_get" ; schema:target <#action_wiki.comment.get> . <#action_wiki.comment.get> a schema:EntryPoint ; schema:name "EntryPoint - wiki_comment_get" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.comment.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.comment.get> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>comment_id</parametername> </parameternamelist> <parameterdescription> <p>The id of the comment.</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>The details of the comment encoded as RDF+XML triples.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.comment.get?comment_id=5555&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 07:04:08 GMT Accept-Ranges: bytes Content-Type: application/sparql-results+xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Get details of a comment. </p>" ; oplwebsrv:hasParameter <#action_wiki.comment.get_#_comment_id> . <#action_wiki.comment.get_#_comment_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "comment_id" ; schema:name "comment_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The id of the comment.</p>" . <#action_429602fd7c998576f4d0479442ca2d22> a schema:Action ; schema:name "wiki_comment_new" ; schema:target <#action_wiki.comment.new> . <#action_wiki.comment.new> a schema:EntryPoint ; schema:name "EntryPoint - wiki_comment_new" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.comment.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.comment.new> ; schema:description "<p>Comments can be put in threads, ie. a comment can have a parent comment. In that case it is considered a reply to the parent comment.</p><p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>topic</parametername> </parameternamelist> <parameterdescription> <p>The topic name </p></parameterdescription> </li> <li> <parameternamelist> <parametername>title</parametername> </parameternamelist> <parameterdescription> <p>The title of the comment. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>text</parametername> </parameternamelist> <parameterdescription> <p>The text body of the comment. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The name of the commenter. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> <p>The email address of the commenter. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> <p>An optional URL to identify the commenter.</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>. If successful the error code matches the id of the newly created comment.</p></simplesect> <simplesect kind=\"see\"><p><ref kindref=\"member\" refid=\"group__ods__module__wiki_1gae72f6fa9c9ded1dde2b1de4401640245\">wiki.comment.delete</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.comment.new?cluster=DemoWiki&topic=Test&title=test&text=simple&name=Kate&email=kate@yahoo.com&url=http://openlinksw.com&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 07:03:15 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result> <code>5555</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Create a new comment on an event or task. </p>" ; oplwebsrv:hasParameter <#action_wiki.comment.new_#_cluster> , <#action_wiki.comment.new_#_topic> , <#action_wiki.comment.new_#_parent_id> , <#action_wiki.comment.new_#_title> , <#action_wiki.comment.new_#_text> , <#action_wiki.comment.new_#_name> , <#action_wiki.comment.new_#_email> , <#action_wiki.comment.new_#_url> . <#action_wiki.comment.new_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.comment.new_#_topic> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "topic" ; schema:name "topic" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name </p>" . <#action_wiki.comment.new_#_parent_id> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "parent_id" ; schema:name "parent_id" ; # oplwebsrv:parameterType "integer" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> . <#action_wiki.comment.new_#_title> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "title" ; schema:name "title" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The title of the comment. </p>" . <#action_wiki.comment.new_#_text> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "text" ; schema:name "text" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The text body of the comment. </p>" . <#action_wiki.comment.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The name of the commenter. </p>" . <#action_wiki.comment.new_#_email> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "email" ; schema:name "email" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The email address of the commenter. </p>" . <#action_wiki.comment.new_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>An optional URL to identify the commenter.</p>" . <#action_729cba6da6eef97dd52310600fa19380> a schema:Action ; schema:name "wiki_options_get" ; schema:target <#action_wiki.options.get> . <#action_wiki.options.get> a schema:EntryPoint ; schema:name "EntryPoint - wiki_options_get" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.options.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.options.get> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The configuration option name. Supported options are:<itemizedlist> <listitem><p>indexPage</p></listitem><listitem><p>skinSource</p></listitem><listitem><p>primarySkin</p></listitem><listitem><p>secondarySkin</p></listitem><listitem><p>wikiPlugin</p></listitem><listitem><p>newTopicTemplate</p></listitem><listitem><p>newCategoryTempate</p></listitem><listitem><p>vhostRegularExpression</p></listitem><listitem><p>deliciousEnabled</p></listitem><listitem><p>webmailEnabled</p></listitem><listitem><p>antiSpam</p></listitem><listitem><p>technoratiApiKey</p></listitem><listitem><p>conversationEnabled</p></listitem><listitem><p>inlineMacros</p></listitem><listitem><p>interClusterAutolinks</p></listitem></itemizedlist> </p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>The configuration option value</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.options.get?cluster=DemoWiki&name=indexPage&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:10:08 GMT Accept-Ranges: bytes Content-Type: text/plain Content-Length: 625 WelcomeVisitors </pre> </p>" ; schema:shortDescription "<p>Get the configuration option of a Wiki instance. </p>" ; oplwebsrv:hasParameter <#action_wiki.options.get_#_cluster> , <#action_wiki.options.get_#_name> . <#action_wiki.options.get_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.options.get_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The configuration option name. Supported options are:<itemizedlist> <listitem><p>indexPage</p></listitem><listitem><p>skinSource</p></listitem><listitem><p>primarySkin</p></listitem><listitem><p>secondarySkin</p></listitem><listitem><p>wikiPlugin</p></listitem><listitem><p>newTopicTemplate</p></listitem><listitem><p>newCategoryTempate</p></listitem><listitem><p>vhostRegularExpression</p></listitem><listitem><p>deliciousEnabled</p></listitem><listitem><p>webmailEnabled</p></listitem><listitem><p>antiSpam</p></listitem><listitem><p>technoratiApiKey</p></listitem><listitem><p>conversationEnabled</p></listitem><listitem><p>inlineMacros</p></listitem><listitem><p>interClusterAutolinks</p></listitem></itemizedlist> </p>" . <#action_ded71b69f3cb2382c41de656b0e47dc5> a schema:Action ; schema:name "wiki_options_set" ; schema:target <#action_wiki.options.set> . <#action_wiki.options.set> a schema:EntryPoint ; schema:name "EntryPoint - wiki_options_set" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.options.set> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.options.set> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The configuration option name<itemizedlist> <listitem><p>indexPage</p></listitem><listitem><p>skinSource</p></listitem><listitem><p>primarySkin</p></listitem><listitem><p>secondarySkin</p></listitem><listitem><p>wikiPlugin</p></listitem><listitem><p>newTopicTemplate</p></listitem><listitem><p>newCategoryTempate</p></listitem><listitem><p>vhostRegularExpression</p></listitem><listitem><p>deliciousEnabled</p></listitem><listitem><p>webmailEnabled</p></listitem><listitem><p>antiSpam</p></listitem><listitem><p>technoratiApiKey</p></listitem><listitem><p>conversationEnabled</p></listitem><listitem><p>inlineMacros</p></listitem><listitem><p>interClusterAutolinks </p></listitem></itemizedlist> </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The configuration option value</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.options.set?cluster=DemoWiki&name=indexPage&value=WelcomeVisitors&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:10:08 GMT Accept-Ranges: bytes Content-Type: text/plain Content-Length: 625 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Set the configuration option of a Wiki instance. </p>" ; oplwebsrv:hasParameter <#action_wiki.options.set_#_cluster> , <#action_wiki.options.set_#_name> , <#action_wiki.options.set_#_value> . <#action_wiki.options.set_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.options.set_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The configuration option name<itemizedlist> <listitem><p>indexPage</p></listitem><listitem><p>skinSource</p></listitem><listitem><p>primarySkin</p></listitem><listitem><p>secondarySkin</p></listitem><listitem><p>wikiPlugin</p></listitem><listitem><p>newTopicTemplate</p></listitem><listitem><p>newCategoryTempate</p></listitem><listitem><p>vhostRegularExpression</p></listitem><listitem><p>deliciousEnabled</p></listitem><listitem><p>webmailEnabled</p></listitem><listitem><p>antiSpam</p></listitem><listitem><p>technoratiApiKey</p></listitem><listitem><p>conversationEnabled</p></listitem><listitem><p>inlineMacros</p></listitem><listitem><p>interClusterAutolinks </p></listitem></itemizedlist> </p>" . <#action_wiki.options.set_#_value> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "value" ; schema:name "value" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> . <#action_635b7b603cb0f0eb209b48d84314936c> a schema:Action ; schema:name "wiki_topic_delete" ; schema:target <#action_wiki.topic.delete> . <#action_wiki.topic.delete> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_delete" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.delete> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name to be delete</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <simplesect kind=\"see\"><p><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga7b702067e20ab47a339c5516028609f5\">wiki.topic.new</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.delete?cluster=DemoWiki&name=Test&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Delete a topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.delete_#_cluster> , <#action_wiki.topic.delete_#_name> . <#action_wiki.topic.delete_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name to be delete</p>" . <#action_45d783d5b32cc296c593ca9a8d0bc35d> a schema:Action ; schema:name "wiki_topic_edit" ; schema:target <#action_wiki.topic.edit> . <#action_wiki.topic.edit> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_edit" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.edit> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name </p></parameterdescription> </li> <li> <parameternamelist> <parametername>content</parametername> </parameternamelist> <parameterdescription> <p>The topic content</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <simplesect kind=\"see\"><p><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga7b702067e20ab47a339c5516028609f5\">wiki.topic.new</ref></p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.edit?cluster=DemoWiki&name=Test&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Modify a topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.edit_#_cluster> , <#action_wiki.topic.edit_#_name> , <#action_wiki.topic.edit_#_content> . <#action_wiki.topic.edit_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name </p>" . <#action_wiki.topic.edit_#_content> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "content" ; schema:name "content" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic content</p>" . <#action_cdde6197c8d59cebb8175bb1ac4762e2> a schema:Action ; schema:name "wiki_topic_get" ; schema:target <#action_wiki.topic.get> . <#action_wiki.topic.get> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_get" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.get> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.get?cluster=DemoWiki&name=Test&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: application/sparql-results+xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Get the details of a specific topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.get_#_cluster> , <#action_wiki.topic.get_#_name> . <#action_wiki.topic.get_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.get_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name</p>" . <#action_7b702067e20ab47a339c5516028609f5> a schema:Action ; schema:name "wiki_topic_new" ; schema:target <#action_wiki.topic.new> . <#action_wiki.topic.new> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_new" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.new> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name </p></parameterdescription> </li> <li> <parameternamelist> <parametername>content</parametername> </parameternamelist> <parameterdescription> <p>The topic content</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.new?cluster=DemoWiki&name=Test&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Create a new topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.new_#_cluster> , <#action_wiki.topic.new_#_name> , <#action_wiki.topic.new_#_content> . <#action_wiki.topic.new_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name </p>" . <#action_wiki.topic.new_#_content> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "content" ; schema:name "content" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic content</p>" . <#action_e9f39bdb106aa5fe5f90ef9b326b2a4d> a schema:Action ; schema:name "wiki_topic_sync" ; schema:target <#action_wiki.topic.sync> . <#action_wiki.topic.sync> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_sync" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.sync> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.sync> ; schema:shortDescription "" ; oplwebsrv:hasParameter <#action_wiki.topic.sync_#_cluster> , <#action_wiki.topic.sync_#_name> . <#action_wiki.topic.sync_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> . <#action_wiki.topic.sync_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> . <#action_b29f785d6b93058262bdf3fe34ecf228> a schema:Action ; schema:name "wiki_topic_versions" ; schema:target <#action_wiki.topic.versions> . <#action_wiki.topic.versions> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_versions" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.versions> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.versions> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.versions?cluster=DemoWiki&name=Test&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Get the details of the versions of the specific topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.versions_#_cluster> , <#action_wiki.topic.versions_#_name> . <#action_wiki.topic.versions_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired false ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.versions_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name</p>" . <#action_15a5d8e3f66d971db4861d1d65ff6cf1> a schema:Action ; schema:name "wiki_topic_versions_diff" ; schema:target <#action_wiki.topic.versions.diff> . <#action_wiki.topic.versions.diff> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_versions_diff" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.versions.diff> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.versions.diff> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name </p></parameterdescription> </li> <li> <parameternamelist> <parametername>version</parametername> </parameternamelist> <parameterdescription> <p>The topic version number</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.versions.diff?cluster=DemoWiki&name=Test&version=1&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Get the diff of the specific version of the specific topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.versions.diff_#_cluster> , <#action_wiki.topic.versions.diff_#_name> , <#action_wiki.topic.versions.diff_#_version> . <#action_wiki.topic.versions.diff_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.versions.diff_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name </p>" . <#action_wiki.topic.versions.diff_#_version> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "version" ; schema:name "version" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic version number</p>" . <#action_deacc95f5b016e50fb5f932072088b13> a schema:Action ; schema:name "wiki_topic_versions_get" ; schema:target <#action_wiki.topic.versions.get> . <#action_wiki.topic.versions.get> a schema:EntryPoint ; schema:name "EntryPoint - wiki_topic_versions_get" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.topic.versions.get> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.topic.versions.get> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the topic </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>The topic name </p></parameterdescription> </li> <li> <parameternamelist> <parametername>version</parametername> </parameternamelist> <parameterdescription> <p>The topic version number</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>A set of RDF triples detailing the event or task encoded as RDF+XML.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.topic.versions.get?cluster=DemoWiki&name=Test&version=1&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:05:58 GMT Accept-Ranges: bytes Content-Type: text/xml Content-Length: 1234 ... </pre> </p>" ; schema:shortDescription "<p>Get the details of the specific version of the specific topic. </p>" ; oplwebsrv:hasParameter <#action_wiki.topic.versions.get_#_cluster> , <#action_wiki.topic.versions.get_#_name> , <#action_wiki.topic.versions.get_#_version> . <#action_wiki.topic.versions.get_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the topic </p>" . <#action_wiki.topic.versions.get_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic name </p>" . <#action_wiki.topic.versions.get_#_version> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "version" ; schema:name "version" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The topic version number</p>" . <#action_d77c206f66cda3441af285832fa261fc> a schema:Action ; schema:name "wiki_upstream_check" ; schema:target <#action_wiki.upstream.check> . <#action_wiki.upstream.check> a schema:EntryPoint ; schema:name "EntryPoint - wiki_upstream_check" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.upstream.check> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.upstream.check> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.upstream.check?url=http://vos.openlinksw.com/dataspace/demo/wiki/demoWiki2/atom-pub\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:28:58 GMT Accept-Ranges: bytes Content-Type: text/plain; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Check a wiki upstream URL. </p>" ; oplwebsrv:hasParameter <#action_wiki.upstream.check_#_url> . <#action_wiki.upstream.check_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_b861d5c5bc09cc685019f0a4c0cbdbfd> a schema:Action ; schema:name "wiki_upstream_delete" ; schema:target <#action_wiki.upstream.delete> . <#action_wiki.upstream.delete> a schema:EntryPoint ; schema:name "EntryPoint - wiki_upstream_delete" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.upstream.delete> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.upstream.delete> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the upstream </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>A human-readable name for the upstream.</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.upstream.delete?cluster=DemoWiki&name=demoUpstream&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:31:09 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Delete a wiki upstream. </p>" ; oplwebsrv:hasParameter <#action_wiki.upstream.delete_#_cluster> , <#action_wiki.upstream.delete_#_name> . <#action_wiki.upstream.delete_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the upstream </p>" . <#action_wiki.upstream.delete_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>A human-readable name for the upstream.</p>" . <#action_50c6359a7bba57e4875535108bf64f42> a schema:Action ; schema:name "wiki_upstream_edit" ; schema:target <#action_wiki.upstream.edit> . <#action_wiki.upstream.edit> a schema:EntryPoint ; schema:name "EntryPoint - wiki_upstream_edit" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.upstream.edit> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.upstream.edit> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the upstream </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>A human-readable name for the upstream. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> <li> <parameternamelist> <parametername>user</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.upstream.edit?cluster=DemoWiki&name=demoUpstream&url=http://vos.openlinksw.com/dataspace/demo/wiki/demoWiki2/atom-pub&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:30:08 GMT Accept-Ranges: bytes Content-Type: text/plain; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Modify a wiki upstream. </p>" ; oplwebsrv:hasParameter <#action_wiki.upstream.edit_#_cluster> , <#action_wiki.upstream.edit_#_name> , <#action_wiki.upstream.edit_#_url> , <#action_wiki.upstream.edit_#_user> , <#action_wiki.upstream.edit_#_password> . <#action_wiki.upstream.edit_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the upstream </p>" . <#action_wiki.upstream.edit_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>A human-readable name for the upstream. </p>" . <#action_wiki.upstream.edit_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_wiki.upstream.edit_#_user> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "user" ; schema:name "user" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_wiki.upstream.edit_#_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "password" ; schema:name "password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_08e13b75c529088b4afb42c25c7de2f3> a schema:Action ; schema:name "wiki_upstream_new" ; schema:target <#action_wiki.upstream.new> . <#action_wiki.upstream.new> a schema:EntryPoint ; schema:name "EntryPoint - wiki_upstream_new" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.upstream.new> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.upstream.new> ; schema:description "<p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the upstream </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>A human-readable name for the new upstream. </p></parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> <li> <parameternamelist> <parametername>user</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> <p /></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>. If successful the error code matches the id of the newly created upstream.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.upstream.new?cluster=DemoWiki&name=demoUpstream&url=http://vos.openlinksw.com/dataspace/demo/wiki/demoWiki2/atom-pub&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Fri, 20 May 2011 08:28:58 GMT Accept-Ranges: bytes Content-Type: text/plain; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Create a new wiki upstream. </p>" ; oplwebsrv:hasParameter <#action_wiki.upstream.new_#_cluster> , <#action_wiki.upstream.new_#_name> , <#action_wiki.upstream.new_#_url> , <#action_wiki.upstream.new_#_user> , <#action_wiki.upstream.new_#_password> . <#action_wiki.upstream.new_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the upstream </p>" . <#action_wiki.upstream.new_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>A human-readable name for the new upstream. </p>" . <#action_wiki.upstream.new_#_url> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "url" ; schema:name "url" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_wiki.upstream.new_#_user> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "user" ; schema:name "user" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_wiki.upstream.new_#_password> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "password" ; schema:name "password" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p />" . <#action_5b209cdd34211ac5e8bd5cfdad0d2d5a> a schema:Action ; schema:name "wiki_upstream_sync" ; schema:target <#action_wiki.upstream.sync> . <#action_wiki.upstream.sync> a schema:EntryPoint ; schema:name "EntryPoint - wiki_upstream_sync" ; schema:url <https://vos.openlinksw.com/ods/api/wiki.upstream.sync> ; schema:httpMethod "GET" ; schema:contentType "text/xml" ; ## OpenLink Web Services Ontology Terms oplwebsrv:isWebServiceOf <#this_ODSWikiModuleAPI> ; oplwebsrv:endPointURL <https://vos.openlinksw.com/ods/api/wiki.upstream.sync> ; schema:description "<p>Manually synchonizes a cluster upstream created with <ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga08e13b75c529088b4afb42c25c7de2f3\">wiki.upstream.new()</ref>. This is required if the subscription has been configured to be manually updated. However, it can also be used to force an update on subscriptions with a scheduled update interval.</p><p><parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> <p>The cluster name of the upstream </p></parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> <p>A human-readable name for the upstream.</p></parameterdescription> </li> </ul> <simplesect kind=\"return\"><p>An error code stating the success of the command execution as detailed in <ref kindref=\"member\" refid=\"ods_response_format_1ods_response_format_result_code\">ODS Error Result Codes</ref>.</p></simplesect> <bold>Example:</bold> <pre> $ curl -i \"http://vos.openlinksw.com/ods/api/wiki.upstream.sync?cluster=DemoWiki&name=demoUpstream&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh\" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 22:40:59 GMT Accept-Ranges: bytes Content-Type: text/xml; charset=\"UTF-8\" Content-Length: 57 <result> <code>1</code> <message>Success</message> </result> </pre> </p>" ; schema:shortDescription "<p>Synchronize a cluster upstream. </p>" ; oplwebsrv:hasParameter <#action_wiki.upstream.sync_#_cluster> , <#action_wiki.upstream.sync_#_name> . <#action_wiki.upstream.sync_#_cluster> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "cluster" ; schema:name "cluster" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>The cluster name of the upstream </p>" . <#action_wiki.upstream.sync_#_name> a oplwebsrv:WebServiceParameter ; oplwebsrv:parameterName "name" ; schema:name "name" ; # oplwebsrv:parameterType "varchar" ; oplwebsrv:isRequired true ; wdrs:describedby <#this_ODSWikiModuleAPIDoc> ; schema:mainEntityOfPage <#this_ODSWikiModuleAPIDoc> ; schema:description "<p>A human-readable name for the upstream.</p>" . </script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="." class="icon icon-home">VOS.VirtSPASQLWebDataServiceApp</a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="/wiki/resources/advanced_search.vspx" method="post"><input type="hidden" name="cluster" value="VOS" /><input type="text" name="q" size="60" id="new_search_txt" value="" /><input name="area" value="default" type="hidden" /> </form> </div> </div><!--Left margin menu--> <div aria-label="main navigation" role="navigation" data-spy="affix" class="wy-menu wy-menu-vertical" style="padding-left: 1em"> <ul class="oplleftmenu"> <li class="oplleftmenutitle">You are here: </li> <li class="toctrlite-l1 tocsoliton breadcrumb">/<a href="http://vos.openlinksw.com/dataspace/owiki/wiki/VOS">VOS</a>/<a href="http://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp">VirtSPASQLWebDataServiceApp</a> </li> <li class="oplleftmenutitle">Tools</li> <li> <a id="loginlink" href="">Login</a> </li> <li class="oplleftmenutitle">Formats <br /> </li> <li> <a rel="nofollow" href="?command=text">Text</a> </li> <li> <a rel="nofollow" href="?command=plain-html">Plain HTML</a> </li> <li> <a rel="nofollow" href="?command=docbook">DocBook</a> </li> <li> <a rel="nofollow" href="?command=export_rdf">Export RDF</a> </li> <li class="oplleftmenutitle">Cluster Changes</li> <li> <img border="0" alt="RSS" title="RSS" src="https://vos.openlinksw.com/wiki/resources/images/rss-icon-12.png" /><a href="https://vos.openlinksw.com/wiki/resources/gems.vsp?type=rss20"> RSS 2.0 </a> </li> <li> <img border="0" alt="RDF" title="RDF" src="https://vos.openlinksw.com/wiki/resources/images/rdf-icon-12.png" /><a href="https://vos.openlinksw.com/wiki/resources/gems.vsp?type=rdf"> RDF </a> </li> <li> <img border="0" alt="SIOC (RDF/XML)" title="SIOC (RDF/XML)" src="https://vos.openlinksw.com/wiki/resources/images/rdf-icon-12.png" /><a href="http://vos.openlinksw.com/dataspace/owiki/wiki/VOS/sioc.rdf "> SIOC (RDF/XML) </a> </li> <li> <img border="0" alt="SIOC (N3/Turtle)" title="SIOC (N3/Turtle)" src="https://vos.openlinksw.com/wiki/resources/images/rdf-icon-12.png" /><a href="http://vos.openlinksw.com/dataspace/owiki/wiki/VOS/sioc.ttl "> SIOC (N3/Turtle) </a> </li> <li class="oplleftmenutitle">Meta</li> <li> Modified by at </li> <li> <br /> Version History:<br /> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?rev=2">1.2</a><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?command=diff&rev=1" alt="View changes between revisions" title="View changes between revisions">></a><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?rev=1">1.1</a> </li> </ul> </div> <div class="wy-menu wy-menu-vertical" data-toggle="rst-versions" role="note" aria-label="versions"> <hr style="width: 50%; text-align: center; margin: 1em;" /> <br /> <dl> <dt style="color: white">OpenLink Software</dt> <dd> <a href="https://www.openlinksw.com/">Home</a> </dd> <dd> <a href="http://uda.openlinksw.com/">Universal Data Access (UDA) <br /> - ODBC, JDBC, ADO.NET and OleDB Drivers </a> </dd> <dd> <a href="http://virtuoso.openlinksw.com/">Virtuoso</a> </dd> <dd> <a href="http://vos.openlinksw.com/漏">Virtuoso Open-Souce Edition</a> </dd> <dd> <a href="http://osde.openlinksw.com/">OpenLink Structured Data Editor</a> </dd> <dd> <a href="http://osds.openlinksw.com/">OpenLink Structured Data Sniffer</a> </dd> <dd> <a href="http://ode.openlinksw.com/">OpenLink Data Explorer (ODE)</a> </dd> <dd> <a href="http://oat.openlinksw.com/">OpenLink AJAX Toolkit (OAT)</a> </dd> <dd> <a href="http://ods.openlinksw.com/wiki/ODS/">OpenLink Data Spaces (ODS)</a> </dd> </dl> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"><i data-toggle="wy-nav-top" class="fa fa-bars"></i><a href=".">Virtuoso Documentation</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <hr /><!--Start body content--><!--Invoked as wiki: cluster=VOS, site=wiki-VOS --> <div id="thecontent"> <div style="display: none"> <li id="wiki-nstab-main" class="selected"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp" id="current-topic">Topic</a> </li> <li id="wiki-nstab-talks"> <a id="current-topic-talks" href="javascript: void(0);" title="Discussion" onclick="javascript: window.open('https://vos.openlinksw.com/wiki/resources/conversation.vspx?fid=557367409', 'conversation', 'width=700,height=650,scrollbars=yes'); return false;"> Discussion </a> </li> <div id="other-output-toolbar"> <span><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp">VOS.VirtSPASQLWebDataServiceApp</a>(Last) </span><span> -- Owiki<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/Owiki?WikiCluster=VOS">? </a>, 2018-04-13 12:07:40</span> <span><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?command=edit">Edit</a> </span><span></span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?command=text">[TXT]</a> </div> </span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?command=plain-html">[PLAIN]</a> </div> </span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLWebDataServiceApp?command=docbook">[DOCBOOK]</a> </div> </span> <span id="top-mod-by"><a href="https://vos.openlinksw.com/dataspace/person/owiki#this">owiki</a> </span><span id="top-mod-time">2018-04-13 12:07:40</span> </div> </div> <div class="topic-text"> <p> </p> <h1> <a name="Creating a Web Browser Application to Access RDF Data Using The Virtuoso ADO.NET Provider"></a> Creating a Web Browser Application to Access RDF Data Using The Virtuoso ADO.NET Provider</h1> <p> </p> <div class="MACRO_TOC"> <div class="wikitoc"> <ul> <li> <a href="#Introduction">Introduction</a> </li> <li> <a href="#Prerequisites">Prerequisites</a> </li> <li> <a href="#Creating%20the%20Web%20Service">Creating the Web Service</a> </li> <ul> <li> <a href="#Step%201%20-%20Create%20a%20view%20of%20the%20RDF%20data">Step 1 - Create a view of the RDF data</a> </li> <li> <a href="#Step%202%20-%20Create%20the%20Visual%20Studio%20Project%20and%20Add%20the%20Model">Step 2 - Create the Visual Studio Project and Add the Model</a> </li> <li> <a href="#Step%203%20-%20Add%20the%20Web%20Service">Step 3 - Add the Web Service</a> </li> <li> <a href="#Step%204%20-%20Compile%20and%20Run">Step 4 - Compile and Run</a> </li> </ul> <li> <a href="#Creating%20the%20Browser%20Application">Creating the Browser Application</a> </li> <ul> <li> <a href="#Step%201%20-%20Create%20the%20Visual%20Studio%20Project">Step 1 - Create the Visual Studio Project</a> </li> <li> <a href="#Step%202%20-%20Display%20the%20contents%20of%20sparqlview%20as%20a%20table%20on%20the%20page">Step 2 - Display the contents of sparqlview as a table on the page</a> </li> </ul> <li> <a href="#Deploy%20With%20IIS">Deploy With IIS</a> </li> <ul> <li> <a href="#Web%20Service">Web Service</a> </li> <li> <a href="#Web%20Application">Web Application</a> </li> </ul> <li> <a href="#Next%20Steps">Next Steps</a> </li> <p> </p> </ul> </div> </div> <h2> <a name="Introduction"></a> Introduction</h2> <p>This document will guide you through creating first a Web Service that exposes RDF data from Virtuoso and then a simple web browser application that consumes the Web Service and allowing you to access and explore the RDF data by clicking on dereferenceable <a href="http://docs.openlinksw.com/virtuoso/rdfdatarepresentation.html#rdfiriidtype" class="absuri">IRIs</a>.</p> <h2> <a name="Prerequisites"></a> Prerequisites</h2> <ol> <li>Microsoft Visual Studio 2008 </li> <li>The Virtuoso ADO.NET provider for .NET 3.5 and the Entity Framework </li> <li>The Virtuoso <a href="https://virtuoso.openlinksw.com/download/" class="absuri">Cartridges VAD package</a> </li> <li>The example assumes that you have a local Virtuoso server with the Northwind demo database installed. If the demo database is not already installed then download the <a href="https://virtuoso.openlinksw.com/download/" class="absuri">demo database VAD package</a> (<code>demo_dav.vad</code>) and install it. The VAD package will create a new database in Virtuoso called demo containing the familiar Northwind tables. It will also create <a href="http://docs.openlinksw.com/virtuoso/rdfsparqlintegrationmiddleware.html#rdfviews" class="absuri">Linked Data Views</a> of the Northwind tables. In the example we assume the database is accessible on a hostname of "<code>demo.openlinksw.com</code>" on the default port <code>80</code>, where an actually live instance of the Virtuoso Demo database is hosted. Users would use the appropriate hostname and port number of their Virtuoso installation to create the sample application, and would be would be <code>localhost:8890</code> for a default installation or whatever the <code>URIQA DefaultHost</code> Virtuoso configuration parameter is set to when the demo database VAD package is installed.</li> </ol> <h2> <a name="Creating the Web Service"></a> Creating the Web Service</h2> <h3> <a name="Step 1 - Create a view of the RDF data"></a> Step 1 - Create a view of the RDF data</h3> <p>To create a view of the customers in the Northwind first open the Virtuoso Conductor and log in as <b><code>dba</code></b>. Then open <b>iSQL</b> from the menu on the left and execute the following statement. </p> <br /> <pre>CREATE VIEW Demo.demo.sparqlview AS SPARQL PREFIX nwind: <http://demo.openlinksw.com/schemas/northwind#> SELECT DISTINCT ?s FROM <http://demo.openlinksw.com/Northwind> WHERE { ?s a nwind:Customer } </pre><p> <b>Note</b>: </p> <ul> <li>If the view is added to the Visual Studio project as user "<code>demo</code>" (or any other than "<code>dba</code>'), then it must be ensured that the "<code>SPARQL_SELECT</code>" and "<code>SPARQL_SPONGE</code>" roles are assigned to this user, which can be done via the Virtuoso Conductor in the <b>System Admin</b> -> <b>User Accounts</b> tab. </li> <li>Execute permissions will also need to be granted to the RDF <u>MAKE_LONG_OF_SQLVAL procedure, with an iSQL statement similar to the following: </u> <br /> <pre><br />GRANT EXECUTE ON DB.DBA.RDF_MAKE_LONG_OF_SQLVAL TO "demo" </pre><br /> <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/isql.png" style="wikiautogen" /> <br /> <br /> </li> </ul> <h3> <a name="Step 2 - Create the Visual Studio Project and Add the Model"></a> Step 2 - Create the Visual Studio Project and Add the Model</h3> <ol> <li>Open <b>Visual Studio</b> and create a new <b>ASP .NET Web Application</b> called <b><code>>RDFWebDemo</code></b>. <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/RDFWebDemo.png" style="wikiautogen" /> <br /> <br /> </li> <li>Right-click <b>RDFWebDemo</b> in the <b>Solution Explorer</b>, and add a new <b>ADO.NET Entity Data Model</b> called <b><code>Model1.edmx</code></b>. This will open the <b>Entity Data Model Wizard</b>. </li> <li>Choose <b>Generate From Database</b> and click <b>Next</b>. </li> <li>Set up a connection to the Demo database on your local Virtuoso Server, select <b>Yes, include the sensitive data in the connection string</b> and set the name of the entities to <b><code>DemoEntities</code></b>. Click <b>Next</b>. </li> <li>On the <b>Choose Your Database Objects</b> page expand <b>Views</b> and select <b><code>sparqlview</code></b>. Check that the <b>Model Namespace</b> is <b>DemoModel</b> and click <b>Finish</b>. <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/sparqlview.png" style="wikiautogen" /> <br /> <br /> </li> </ol> <h3> <a name="Step 3 - Add the Web Service"></a> Step 3 - Add the Web Service</h3> <ol> <li>Right click <b>RDFWebDemo</b> in the <b>Solution Explorer</b> and add a new <b>ADO.NET Data Service</b> called <b><code>WebDataService1.svc</code></b>. Click <b>Add</b>. </li> <li>In the class definition of <b>WebDataService1</b> in the newly created file <b><code>WebDataService1.svc.cs</code></b> replace "<code>/* TODO: put your data source class name here */</code>" with the name of our model, <b><code>DemoEntities</code></b>. <br /> <pre><br />public class WebDataService1 : DataService<DemoEntities> </pre><br /> </li> <li>In the <b>InitializeService</b> method, add the line: <br /> <pre><br />config.SetEntitySetAccessRule("*", EntitySetRights.All); </pre><br />The method should look like this <br /> <pre><br />public static void InitializeService(IDataServiceConfiguration config) { // TODO: set rules to indicate which entity sets and service operations are visible, updatable, etc. // Examples: // config.SetEntitySetAccessRule("MyEntityset", EntitySetRights.AllRead); // config.SetServiceOperationAccessRule("MyServiceOperation", ServiceOperationRights.All); config.SetEntitySetAccessRule("*", EntitySetRights.All); } </pre><br /> </li> </ol> <h3> <a name="Step 4 - Compile and Run"></a> Step 4 - Compile and Run</h3> Hit <b>F5</b> to compile and run the service. Click <b>OK</b> when prompted to enable debugging. The default browser will be launched showing a page like -- <br /> <pre> <?xml version="1.0" encoding="utf-8" standalone="yes" ?> - <service xml:base="http://localhost:1241/WebDataService1.svc/" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:app="http://www.w3.org/2007/app" xmlns="http://www.w3.org/2007/app"> - <workspace> <atom:title>Default</atom:title> - <collection href="sparqlview"> <atom:title>sparqlview</atom:title> </collection> </workspace> </service> </pre><p>The service is now running.</p> <i>Note the address on which the service is made available. You will need to know this when creating the app to consume the service. Look in the Address Bar of the browser. It will be something like:</i> <b><code>http://localhost:1492/WebDataService1.svc/</code></b> <h2> <a name="Creating the Browser Application"></a> Creating the Browser Application</h2> <h3> <a name="Step 1 - Create the Visual Studio Project"></a> Step 1 - Create the Visual Studio Project</h3> <ol> <li>Open <b>Visual Studio</b> and create a new <b>ASP.NET Web Application</b> called <b><code>RDFWebApp</code></b>. <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/RDFWebApp.png" style="wikiautogen" /> <br /> <br /> </li> <li>Create client side entities with <b><code>datasvcutil.exe</code></b>. <ol> <li>Open a command prompt. </li> <li>Navigate to <b><code>C:\WINDOWS\Microsoft.NET\Framework\v3.5</code></b>. </li> <li>Generate the client classes using the following command: <br /> <pre><br />datasvcutil.exe /uri:http://localhost:1492/WebDataService1.svc /out:DemoEntities.cs </pre><br /> <i>Note the address of the service. You may need to change the port number to match the one seen in the address at the end of Step 4 in Creating the Web Service</i>. </li> </ol> </li> <li>Add the classes to <b>RDFWebApp</b>. <ol> <li>Right click <b>RDFWebApp</b>. </li> <li>Choose to add an existing item and add <b><code>c:\WINDOWS\Microsoft.NET\Framework\v3.5\DemoEntities.cs</code></b>. </li> </ol> </li> <li>Add a reference to <b><code>System.Data.Services.Client</code></b> to the project.</li> </ol> <h3> <a name="Step 2 - Display the contents of sparqlview as a table on the page"></a> Step 2 - Display the contents of sparqlview as a table on the page</h3> <p>To display the RDF data on the web page, we create a table with a row for each item in sparqlview. We then use each IRI from sparqlview to create a hyperlink. The hyperlinks are displayed in the table cells. To do this, add the following block of code to the <b><code>page_load</code></b> method in <b><code>Default.aspx.cs</code></b>. </p> <br /> <pre>DemoModel.DemoEntities svc = new DemoModel.DemoEntities(new Uri("http://localhost:1492/WebDataService1.svc")); var query = svc.sparqlview; Table iriTable = new Table(); this.Controls.Add(iriTable); foreach (DemoModel.sparqlview sv in query) { TableRow tRow = new TableRow(); iriTable.Rows.Add(tRow); TableCell tCell = new TableCell(); tRow.Cells.Add(tCell); HyperLink h = new HyperLink(); h.Text = sv.s; h.NavigateUrl = sv.s; tCell.Controls.Add(h); } </pre><i>Note the address of the service in the first line. You may need to change the port number to match the one seen in the address at the end of Step 4 in Creating the Web Service</i>.<p>Compile and run <b>RDFWebApp</b> (ensuring that the service created above is still running). This will launch a browser and display the IRIs from sparqlview as a list of hyperlinks. <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/DefaultPage.png" style="wikiautogen" /> <br /> <br /> </p> <p>With the <a href="https://virtuoso.openlinksw.com/download/" class="absuri">Cartridges VAD package</a> installed in Virtuoso, clicking on these links will take you to a description page of the referenced resource. The description page is created using <code><a href="http://virtuoso.openlinksw.com/Whitepapers/html/vdld_html/VirtDeployingLinkedDataGuide_Glossary.html#mozTocId13075" class="absuri">description.vsp</a></code>. <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/Description.png" style="wikiautogen" /> <br /> <br /> </p> <h2> <a name="Deploy With IIS"></a> Deploy With IIS</h2> <p>We have used the Visual Studio Development Server to create and test this simple Web Service. This section describes how to deploy the service using IIS.</p> <h3> <a name="Web Service"></a> Web Service</h3> <p>To deploy the service using IIS: </p> <ol> <li>Open the <b>RDFWebDemo</b> project in Visual Studio, go to the <b>Project</b> menu and select RDFWebDemo <b>Properties.</b> </li> <li>Select the <b>Web</b> tab and scroll down to the <b>Servers</b> section. Select <b>Use local IIS Server</b>. The project URL defaults to using localhost. </li> <li>Click the <b>Create Virtual Directory</b> button then check that the Service works on localhost. </li> <li>Build the project; then start without debugging (ctrl-F5).</li> </ol> <p>The start page that you see when you test the service will look the same as before but the address in the browser bar will be something like <b><code>http://localhost/RDFWebDemo1/WebDataService1.svc/</code></b>. You can now access your service remotely using the hostname or IP address of your server.</p> <p>If at this point you get an <b>Access is denied</b> error, <b>401.3</b>, then you will need to add the Internet Guest Account (<code>IUSR_XXX</code> where <code>XXX</code> is your computer name) to the users allowed to access the folder containing the RDFWebDemo project.</p> <h3> <a name="Web Application"></a> Web Application</h3> <p>You will now need to modify RDFWebApp to access the service at the new address. At the same time we will also change RDFWebApp so that it too is deployed using IIS </p> <ol> <li>Open The RDFWebApp project in Visual Studio. </li> <li>Go to the <b>Project</b> menu and select RDFWebApp <b>Properties.</b> </li> <li>Select the <b>Web</b> tab and scroll down to the <b>Servers</b> section. Select <b>Use local IIS Server</b>. The project URL defaults to using localhost. </li> <li>Click the <b>Create Virtual Directory</b> button. The web application will then run on the local IIS. </li> <li>To reference the web service running on IIS you will need to edit <b><code>Default.aspx.cs</code></b>. Change <br /> <pre><br />DemoModel.DemoEntities svc = new DemoModel.DemoEntities(new Uri("http://localhost:1492/WebDataService1.svc")); </pre><br />to <br /> <pre><br />DemoModel.DemoEntities svc = new DemoModel.DemoEntities(new Uri("http://localhost/RDFWebDemo/WebDataService1.svc/")); </pre><br /> </li> <li>Build the project then start without debugging (ctrl-F5).</li> </ol> <p>The web application is accessible on <b><code>http://localhost/RDFWebApp/Default.aspx</code></b> and can also be accessed using the hostname or IP address of your server, e.g., <b><code>http://192.168.7.129/RDFWebApp/Default.aspx</code></b> </p> <br /> <br /> <img src="VirtSPASQLWebDataServiceApp/firefox.png" style="wikiautogen" /> <br /> <br /> <h2> <a name="Next Steps"></a> Next Steps</h2> This example showed you how to quickly create an ADO.NET Data Service that exposes RDF data in Virtuoso and how to create a basic Web application to consume that service. The next step is to create a Silverlight Application to consume the same service.<ul> <li> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtSPASQLSilverLightApp" class="wikiword">Creating a Silverlight Application to consume the service</a> </li> </ul> <p> </p> <Versions></Versions><tags></tags> </div> </div><!--End body content--> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"></div> <hr /> <div role="contentinfo" class="contentinfo"> <p> 漏 Copyright <a href="https://www.openlinksw.com/">OpenLink Software </a> 2016- <br /> OpenLink Software Documentation Team <virtuoso.docs@openlinksw.com> </p> </div> </footer> </div> </div> </div> </section> </div> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); $("footer >div.contentinfo p").html(' 漏 Copyright <a href="https://www.openlinksw.com/">OpenLink Software </a> '+(new Date).getFullYear()+'- <br /> OpenLink Software Documentation Team <virtuoso.docs@openlinksw.com>') </script> <!--Begin OSDI data--> <!--OSDI structured data injection end--> <script type="text/javascript"> document.getElementById("HD_ODS_BAR").style.cssText = 'position:relative; top: -1em;'; if (document.location.toString().indexOf("advanced_search.vspx") > 0) { ["head", "head-cols", "wiki-path", "hdr-search-form-ctr"].forEach(function (cls) { var elid = document.getElementById(cls); if (elid) { elid.parentElement.removeChild(elid); } }) } </script><script type="text/javascript"> $("#loginlink").attr("href", "/ods//login.vspx?URL=" + encodeURI(document.location)); </script><!--Google tag (gtag.js)--><script async="async" type="text/javascript" src="https://www.googletagmanager.com/gtag/js?id=G-ST19C236MC"></script><script type="text/javascript"> window.dataLayer = window.dataLayer || []; function gtag() { dataLayer.push(arguments); } gtag('js', new Date()); gtag('config', 'G-ST19C236MC'); </script> </body> </html>