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.VirtProgressEntityFrameworkUsage</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/VirtProgressEntityFrameworkUsage">VirtProgressEntityFrameworkUsage</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/VirtProgressEntityFrameworkUsage?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/VirtProgressEntityFrameworkUsage" 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=383500277', '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/VirtProgressEntityFrameworkUsage">VOS.VirtProgressEntityFrameworkUsage</a>(Last) </span><span> -- DAVWikiAdmin<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/DAVWikiAdmin?WikiCluster=VOS">? </a>, 2017-06-29 07:39:36</span> <span><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressEntityFrameworkUsage?command=edit">Edit</a> </span><span></span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressEntityFrameworkUsage?command=text">[TXT]</a> </div> </span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressEntityFrameworkUsage?command=plain-html">[PLAIN]</a> </div> </span> <span> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressEntityFrameworkUsage?command=docbook">[DOCBOOK]</a> </div> </span> <span id="top-mod-by"><a href="https://vos.openlinksw.com/dataspace/person/dav#this">WebDAV System Administrator</a> </span><span id="top-mod-time">2017-06-29 07:39:36</span> </div> </div> <div class="topic-text"> <div id="warning" style="display: none; color: red; background-color: #eaeaea; font-size: 120%; border: solid 1px silver; padding: 0.1em; margin-top: 1em; margin-bottom: 1em">WARNING! This URL (in the Main cluster) is no longer the authoritative source for this page; it has been moved to the VOS or ODS cluster as appropriate instead. See Tim Haynes in case of confusion.</div> <script type="text/javascript"> if(window.location.href.match(//Main//)) { document.getElementById('warning').style.display='block'; } else { document.getElementById('warning').style.display='none'; } </script><p> <p> </p> </p> <h1> <a name="Using Microsoft Entity Frameworks to Access Progress Schema Objects with Virtuoso"></a> Using Microsoft Entity Frameworks to Access Progress Schema Objects with Virtuoso</h1> <p>This document details the steps required to provide Microsoft Entity Framework access to Progress Schema Objects using the <nop></nop>OpenLink Virtuoso Universal Server. This is achieved by Linking the required Progress Schema objects into Virtuoso using its built-in Virtual Database engine and then using the Virtuoso ADO.Net Entity Framework provider to query the remote Progress Schema objects linked into the Virtuoso Server.</p> <p> <p> </p> <div class="MACRO_TOC"> <div class="wikitoc"> <ul> <li> <a href="#Prerequisites">Prerequisites</a> </li> <li> <a href="#Tasks">Tasks</a> </li> <p> </p> </ul> </div> </div> </p> <h2> <a name="Prerequisites"></a> Prerequisites</h2> <p>The following must be in place to complete this exercise.</p> <ol> <li> <b>Microsoft Visual Studio 2008 SP1 (or later)</b> <br /> Microsoft Visual Studio 2008 Service Pack 1 (or later) is required, as previous versions do not include the necessary Entity Framework support.<br /> <br /> </li> <li> <b>Virtuoso ADO.NET Entity Framework Provider, v5.10 or later</b> <br /> The ADO.NET Entity Framework Provider must be installed on the Visual Studio development and deployment host(s). Version 5.10.x or later is required, as previous versions do not include the necessary Entity Frameworks support.<br /> <br /> </li> <li> <b>Virtuoso Universal Server, v5.10 or later</b> <br /> Virtuoso Universal Server Release 5.10 or later is required, as previous versions do not include the necessary Entity Frameworks support. This may be on any host which is TCP/IP accessible from the Visual Studio development and deployment host(s).<br /> <br /> </li> <li> <b>ODBC Driver for Progress</b> <br /> The Virtuoso Server uses an ODBC Driver for Progress to link in the Progress Schema Objects. The <b><nop></nop>OpenLink Single-Tier ODBC Driver for Progress (SQL-92)</b> will be used in this document, and a functional ODBC Data Source Name (DSN) of "<b><code>prs101c</code></b>" will be assumed to exist on the machine hosting the Virtuoso Server. Any ODBC compliant driver for Progress should work.<br /> <br /> </li> <li> <b>Progress DBMS</b> <br /> An Progress DBMS hosting the required Schema Objects needs to be available. This may be on any host which is TCP/IP accessible from the Virtuoso Server host. In this document, the Progress <nop></nop>OpenEdge 10 <b>isports</b> database will be used to demonstrate the process.<br /> <br /> </li> </ol> <p> </p> <h2> <a name="Tasks"></a> Tasks</h2> <ol> <li> <b>Ensure Progress Primary Keys (PKs) are not nullable</b> <br /> The Visual Studio 2008 Entity Data Model (EDM) requires that all primary keys are <b>NOT</b> Nullable, and will fail to generate an EDM if any are. Therefore, ensure any applicable primary keys are defined as not nullable in the Progress database schema before attempting to generate an EDM. In the case of the Progress isports database, several primary keys (PKs) <b>are</b> nullable. This issue is best addressed in the database schema, by <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressPKNull" class="wikiword">redefining those nullable PKs</a> to be non-nullable (or <b>Mandatory</b>, in the terms Progress uses).<br /> <br /> </li> <li> <b><a href="http://wikis.openlinksw.com/dataspace/owiki/wiki/UdaWikiWeb/InstallConfigODBC" class="absuri">Install and configure the OpenLink ODBC Driver for Progress (SQL-92)</a> </b> <br /> <br /> </li> <li> <b> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtADOClientServInstall" class="wikiword">Install and configure <nop>OpenLink Virtuoso Universal Server</nop> </a> </b> <br /> <br /> </li> <li> <b><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressLinkingObjects" class="wikiword">Link Progress tables and other schema objects into OpenLink Virtuoso</a> </b> <br /> <br /> </li> <li> <b><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressEDM" class="wikiword">Create a Visual Studio-hosted Entity Data Model (EDM)</a> </b> <br /> <br />If entity-linking associations (i.e., Foreign Keys) are not automatically created (as they are not here with Progress), the <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressAssociations" class="wikiword">associations must be created manually</a>.<br /> <br /> </li> <li> <b><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkProgressDatService" class="wikiword">Use the EDM to create an Entity Frameworks-based ADO.NET Data Service</a> </b> <br /> <br /> </li> <li> <b><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtProgressVisualStudioDataGridFormsApp" class="wikiword">Use the EDM to create an Entity Frameworks-based Windows DataGrid Form Application</a> </b> <br /> </li> </ol> <p> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CategoryDocumentation" class="wikiword">CategoryDocumentation</a> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CategoryVirtuoso" class="wikiword">CategoryVirtuoso</a> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CategoryEntityFrameworks" class="wikiword">CategoryEntityFrameworks</a> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CategoryDotNET" class="wikiword">CategoryDotNET</a> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CategoryProgress" class="wikiword">CategoryProgress</a> </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>