<!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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>comment_id</parametername> </parameternamelist> <parameterdescription> The numerical id of the comment to delete.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga429602fd7c998576f4d0479442ca2d22\">wiki.comment.new</ref></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> " ; schema:shortDescription "Delete a comment. " ; 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 "The numerical id of the comment to delete." . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>comment_id</parametername> </parameternamelist> <parameterdescription> The id of the comment.</parameterdescription> </li> </ul> <simplesect kind=\"return\">The details of the comment encoded as RDF+XML triples.</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> " ; schema:shortDescription "Get details of a comment. " ; 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 "The id of the comment." . <#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 "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.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>topic</parametername> </parameternamelist> <parameterdescription> The topic name </parameterdescription> </li> <li> <parameternamelist> <parametername>title</parametername> </parameternamelist> <parameterdescription> The title of the comment. </parameterdescription> </li> <li> <parameternamelist> <parametername>text</parametername> </parameternamelist> <parameterdescription> The text body of the comment. </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The name of the commenter. </parameterdescription> </li> <li> <parameternamelist> <parametername>email</parametername> </parameternamelist> <parameterdescription> The email address of the commenter. </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> An optional URL to identify the commenter.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__wiki_1gae72f6fa9c9ded1dde2b1de4401640245\">wiki.comment.delete</ref></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> " ; schema:shortDescription "Create a new comment on an event or task. " ; 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 "The cluster name of the topic " . <#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 "The topic name " . <#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 "The title of the comment. " . <#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 "The text body of the comment. " . <#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 "The name of the commenter. " . <#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 "The email address of the commenter. " . <#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 "An optional URL to identify the commenter." . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The configuration option name. Supported options are:<itemizedlist> <listitem>indexPage</listitem><listitem>skinSource</listitem><listitem>primarySkin</listitem><listitem>secondarySkin</listitem><listitem>wikiPlugin</listitem><listitem>newTopicTemplate</listitem><listitem>newCategoryTempate</listitem><listitem>vhostRegularExpression</listitem><listitem>deliciousEnabled</listitem><listitem>webmailEnabled</listitem><listitem>antiSpam</listitem><listitem>technoratiApiKey</listitem><listitem>conversationEnabled</listitem><listitem>inlineMacros</listitem><listitem>interClusterAutolinks</listitem></itemizedlist> </parameterdescription> </li> </ul> <simplesect kind=\"return\">The configuration option value</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> " ; schema:shortDescription "Get the configuration option of a Wiki instance. " ; 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 "The cluster name of the topic " . <#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 "The configuration option name. Supported options are:<itemizedlist> <listitem>indexPage</listitem><listitem>skinSource</listitem><listitem>primarySkin</listitem><listitem>secondarySkin</listitem><listitem>wikiPlugin</listitem><listitem>newTopicTemplate</listitem><listitem>newCategoryTempate</listitem><listitem>vhostRegularExpression</listitem><listitem>deliciousEnabled</listitem><listitem>webmailEnabled</listitem><listitem>antiSpam</listitem><listitem>technoratiApiKey</listitem><listitem>conversationEnabled</listitem><listitem>inlineMacros</listitem><listitem>interClusterAutolinks</listitem></itemizedlist> " . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The configuration option name<itemizedlist> <listitem>indexPage</listitem><listitem>skinSource</listitem><listitem>primarySkin</listitem><listitem>secondarySkin</listitem><listitem>wikiPlugin</listitem><listitem>newTopicTemplate</listitem><listitem>newCategoryTempate</listitem><listitem>vhostRegularExpression</listitem><listitem>deliciousEnabled</listitem><listitem>webmailEnabled</listitem><listitem>antiSpam</listitem><listitem>technoratiApiKey</listitem><listitem>conversationEnabled</listitem><listitem>inlineMacros</listitem><listitem>interClusterAutolinks </listitem></itemizedlist> </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The configuration option value</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</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> " ; schema:shortDescription "Set the configuration option of a Wiki instance. " ; 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 "The cluster name of the topic " . <#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 "The configuration option name<itemizedlist> <listitem>indexPage</listitem><listitem>skinSource</listitem><listitem>primarySkin</listitem><listitem>secondarySkin</listitem><listitem>wikiPlugin</listitem><listitem>newTopicTemplate</listitem><listitem>newCategoryTempate</listitem><listitem>vhostRegularExpression</listitem><listitem>deliciousEnabled</listitem><listitem>webmailEnabled</listitem><listitem>antiSpam</listitem><listitem>technoratiApiKey</listitem><listitem>conversationEnabled</listitem><listitem>inlineMacros</listitem><listitem>interClusterAutolinks </listitem></itemizedlist> " . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name to be delete</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga7b702067e20ab47a339c5516028609f5\">wiki.topic.new</ref></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> " ; schema:shortDescription "Delete a topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name to be delete" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name </parameterdescription> </li> <li> <parameternamelist> <parametername>content</parametername> </parameternamelist> <parameterdescription> The topic content</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</simplesect> <simplesect kind=\"see\"><ref kindref=\"member\" refid=\"group__ods__module__wiki_1ga7b702067e20ab47a339c5516028609f5\">wiki.topic.new</ref></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> " ; schema:shortDescription "Modify a topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name " . <#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 "The topic content" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</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> " ; schema:shortDescription "Get the details of a specific topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name </parameterdescription> </li> <li> <parameternamelist> <parametername>content</parametername> </parameternamelist> <parameterdescription> The topic content</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</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> " ; schema:shortDescription "Create a new topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name " . <#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 "The topic content" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</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> " ; schema:shortDescription "Get the details of the versions of the specific topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name </parameterdescription> </li> <li> <parameternamelist> <parametername>version</parametername> </parameternamelist> <parameterdescription> The topic version number</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</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> " ; schema:shortDescription "Get the diff of the specific version of the specific topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name " . <#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 "The topic version number" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the topic </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> The topic name </parameterdescription> </li> <li> <parameternamelist> <parametername>version</parametername> </parameternamelist> <parameterdescription> The topic version number</parameterdescription> </li> </ul> <simplesect kind=\"return\">A set of RDF triples detailing the event or task encoded as RDF+XML.</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> " ; schema:shortDescription "Get the details of the specific version of the specific topic. " ; 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 "The cluster name of the topic " . <#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 "The topic name " . <#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 "The topic version number" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</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> " ; schema:shortDescription "Check a wiki upstream URL. " ; 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 "" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the upstream </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A human-readable name for the upstream.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</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> " ; schema:shortDescription "Delete a wiki upstream. " ; 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 "The cluster name of the upstream " . <#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 "A human-readable name for the upstream." . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the upstream </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A human-readable name for the upstream. </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>user</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</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> " ; schema:shortDescription "Modify a wiki upstream. " ; 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 "The cluster name of the upstream " . <#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 "A human-readable name for the upstream. " . <#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 "" . <#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 "" . <#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 "" . <#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 "<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the upstream </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A human-readable name for the new upstream. </parameterdescription> </li> <li> <parameternamelist> <parametername>url</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>user</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> <li> <parameternamelist> <parametername>password</parametername> </parameternamelist> <parameterdescription> </parameterdescription> </li> </ul> <simplesect kind=\"return\">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.</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> " ; schema:shortDescription "Create a new wiki upstream. " ; 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 "The cluster name of the upstream " . <#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 "A human-readable name for the new upstream. " . <#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 "" . <#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 "" . <#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 "" . <#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 "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.<parameterlist kind=\"param\"><li> <parameternamelist> <parametername>cluster</parametername> </parameternamelist> <parameterdescription> The cluster name of the upstream </parameterdescription> </li> <li> <parameternamelist> <parametername>name</parametername> </parameternamelist> <parameterdescription> A human-readable name for the upstream.</parameterdescription> </li> </ul> <simplesect kind=\"return\">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>.</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> " ; schema:shortDescription "Synchronize a cluster upstream. " ; 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 "The cluster name of the upstream " . <#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 "A human-readable name for the upstream." . </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.VirtEntityFrameworkSchoolDbWinFormApp</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> <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/VirtEntityFrameworkSchoolDbWinFormApp">VirtEntityFrameworkSchoolDbWinFormApp</a> </li> <li class="oplleftmenutitle">Tools</li> <li> <a id="loginlink" href="">Login</a> </li> <li class="oplleftmenutitle">Formats </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> Version History: <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?rev=2">1.2</a><a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?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/VirtEntityFrameworkSchoolDbWinFormApp?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;" /> <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) - 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"><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 /> <div id="thecontent"> <div style="display: none"> <li id="wiki-nstab-main" class="selected"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp" 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=957498629', 'conversation', 'width=700,height=650,scrollbars=yes'); return false;"> Discussion </a> </li> <div id="other-output-toolbar"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp">VOS.VirtEntityFrameworkSchoolDbWinFormApp</a>(Last) -- Owiki<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/Owiki?WikiCluster=VOS">? </a>, 2018-04-13 12:06:19 <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?command=edit">Edit</a> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?command=text">[TXT]</a> </div> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?command=plain-html">[PLAIN]</a> </div> <div class="wiki-source-type"> <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/VirtEntityFrameworkSchoolDbWinFormApp?command=docbook">[DOCBOOK]</a> </div> <a href="https://vos.openlinksw.com/dataspace/person/owiki#this">owiki</a> 2018-04-13 12:06:19 </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> <h1> <a name="Virtuoso Entity Framework School DB Windows Form Application"></a> Virtuoso Entity Framework School DB Windows Form Application</h1> <div class="MACRO_TOC"> <div class="wikitoc"> <ul> <li> <a href="#Introduction">Introduction</a> </li> <li> <a href="#Pre-requisites">Pre-requisites</a> </li> <li> <a href="#Create%20the%20School%20database%20and%20schema">Create the School database and schema</a> </li> <ul> <li> <a href="#Create%20the%20Course%20Manager%20application%20using%20Visual%20Studio">Create the Course Manager application using Visual Studio</a> </li> <li> <a href="#Create%20the%20Course%20Viewer%20form">Create the Course Viewer form</a> </li> </ul> <li> <a href="#Generating%20the%20School%20Entity%20Data%20Mode">Generating the School Entity Data Mode</a> </li> <ul> <li> <a href="#Add%20the%20ADO.NET%20Entity%20Data%20Model%20item%20template">Add the ADO.NET Entity Data Model item template</a> </li> <li> <a href="#Generate%20the%20EDM">Generate the EDM</a> </li> <li> <a href="#View%20the%20EDM%20in%20the%20ADO.NET%20Entity%20Data%20Model%20Designer">View the EDM in the ADO.NET Entity Data Model Designer</a> </li> </ul> <li> <a href="#Querying%20Entities%20and%20Associations">Querying Entities and Associations</a> </li> <ul> <li> <a href="#Query%20the%20departments%20in%20the%20School%20database">Query the departments in the School database</a> </li> <li> <a href="#Display%20courses%20for%20the%20selected%20department">Display courses for the selected department</a> </li> </ul> <li> <a href="#Inserting%20and%20Updating%20Data">Inserting and Updating Data</a> </li> <ul> <li> <a href="#Save%20changes%20made%20to%20objects">Save changes made to objects</a> </li> <li> <a href="#Build%20and%20run%20the%20Class%20Scheduling%20application">Build and run the Class Scheduling application</a> </li> </ul> </ul> </div> </div> <h2> <a name="Introduction"></a> Introduction</h2> This tutorial demonstrates how Visual Studio 2008 can be used to generate mapping files for an Entity Data Model (EDM), based on a 1:1 mapping to tables in the School database. This will be done by creating a Windows Forms application in Visual Studio, create queries that access data in the School model, bind the query results to display controls to show the results of the queries, and then make updates to objects and persist the changes to the database. <h2> <a name="Pre-requisites"></a> Pre-requisites</h2> <ol> <li>Microsoft Visual Studio 2008 SP1, which includes the ADO.NET Entity Framework runtime and associated tools </li> <li>A running Virtuoso Universal Server instance</li> </ol> <h2> <a name="Create the School database and schema"></a> Create the School database and schema</h2> <ol> <li>Download the <a href="https://virtuoso.openlinksw.com/download/" style="wikiautogen">Schools Database</a> VAD (<code>schools_db_dav.vad</code>) package. </li> <li>Navigate to the System Admin -> Packages tab of the Virtuoso Conductor. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_1.png" style="wikiautogen" /> </li> <li>Scroll down to the Install Package section of the tab, use the Upload Package option Browse button to locate the <code>schools_db_dav.vad</code> package and click proceed. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_2.png" style="wikiautogen" /> </li> <li>Click the Proceed button to begin the installation process. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_3.png" style="wikiautogen" /> </li> <li>Once complete return to the Packages tab and scroll down to confirm the *schools_db* package is listed as installed. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_4.png" style="wikiautogen" /> </li> </ol> <h3> <a name="Create the Course Manager application using Visual Studio"></a> Create the Course Manager application using Visual Studio</h3> <ol> <li>Launch the Visual Studio 2008 SP1 IDE. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtAdoNetDataServices_1.png" style="wikiautogen" /> </li> <li>On the File menu click New Project. </li> <li>Choose either Visual Basic or *Visual C#* in the Project Types pane. </li> <li>Select Windows Forms Application in the Templates pane. </li> <li>Enter CourseManager<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseManager&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> for the project name, and then click OK. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_5.png" style="wikiautogen" /> </li> </ol> <h3> <a name="Create the Course Viewer form"></a> Create the Course Viewer form</h3> <ol> <li>In the CourseManager<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseManager&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> project, select the default form (Form1). </li> <li>In the File Properties pane, change the File Name to CourseViewer.vb or CourseViewer.cs. </li> <li>In Solution Explorer, double-click CourseViewer.vb or CourseViewer.cs to open the form. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_6.png" style="wikiautogen" /> </li> <li>In the Toolbox, expand Common Controls, drag the ComboBox<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/ComboBox&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> control to the form, and change the name of the control to departmentList. </li> <li>In the Toolbox, drag the Button control to the form, change the Name of the control to closeForm, and change the Text value to Close. </li> <li>In the Toolbox, expand Data, drag the DataGridView<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/DataGridView&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> control to the form, and change the Name of the control to courseGridView. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_7.png" style="wikiautogen" /> </li> <li>Double-click the closeForm button control. This opens the code page for the form and creates the closeForm_Click event handler method. </li> <li>In the closeForm_Click event handler method, type the following code that closes the form: <pre> Visual Basic ' Close the form. Me.Close() C# // Close the form. this.Close(); </pre> </li> </ol> <h2> <a name="Generating the School Entity Data Mode"></a> Generating the School Entity Data Mode</h2> <h3> <a name="Add the ADO.NET Entity Data Model item template"></a> Add the ADO.NET Entity Data Model item template</h3> <ol> <li>Select the CourseManager<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseManager&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> project in Solution Explorer, right-click, point to Add, and then click New Item. </li> <li>Select ADO.NET Entity Data Model in the Templates pane. </li> <li>Type School.edmx for the model name and click Add. The opening page of the Entity Data Model Wizard is displayed. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_8.png" style="wikiautogen" /> </li> </ol> <h3> <a name="Generate the EDM"></a> Generate the EDM</h3> <ol> <li>Select Generate from database in the Choose Model Contents dialog box. Then click Next. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_9.png" style="wikiautogen" /> </li> <li>Click the New Connection button. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_10.png" style="wikiautogen" /> </li> <li>Choose the <a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/OpenLink" class="wikiword">OpenLink</a> Virtuoso Data Source and click Continue. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_11.png" style="wikiautogen" /> </li> <li>In the Add Connection dialog, specify the hostname, portno, username, and password for the target Virtuoso Server and check the Save Password check box. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_12.png" style="wikiautogen" /> </li> <li>Select the Select Database From List radio button and choose School from the drop down list of available databases. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_13.png" style="wikiautogen" /> </li> <li>Click the Test Connection button to verify the connection is successful and then click OK to add the connection. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_14.png" style="wikiautogen" /> </li> <li>Set the entity connect string name to SchoolEntities<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/SchoolEntities&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> and click Next. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_15.png" style="wikiautogen" /> </li> <li>In the Choose your Database Objects page select the Tables check box to select all table in the School database for addition to the EDM, set the Model Namespace to SchoolModel<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/SchoolModel&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> and click Finish. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_16.png" style="wikiautogen" /> </li> </ol> <h3> <a name="View the EDM in the ADO.NET Entity Data Model Designer"></a> View the EDM in the ADO.NET Entity Data Model Designer</h3> <ol> <li>In the Solution Explorer, double-click the School.edmx file. This displays the School model in the ADO.NET Entity Data Model Designer window. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_17.png" style="wikiautogen" /> </li> <li>From the View menu, select Other Windows, and then click Model Browser to display the Entity Model Browser window. </li> <li>Expand the SchoolModel<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/SchoolModel&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> and SchoolModel.Store nodes to view conceptual and store definitions, respectively. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_20.png" style="wikiautogen" /> </li> <li>From the View menu, select Other Windows, click Mapping Details, and then click an entity (Person for example) or association in the Entity Designer. </li> <li>This displays the Entity Mapping Details window with information about the object-relational mapping for the selected object. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_21.png" style="wikiautogen" /> </li> </ol> <h2> <a name="Querying Entities and Associations"></a> Querying Entities and Associations</h2> This section creates strongly-typed queries against the CLR objects that represent entities and associations in the School model, and bind display controls to the object collections returned from these queries. <h3> <a name="Query the departments in the School database"></a> Query the departments in the School database</h3> <ol> <li>At the beginning of the code file for the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form, add the following using (C#) or Imports (Visual Basic) statements to reference the model created from the School database and the entity namespace. <pre> Visual Basic Imports System.Data.Objects Imports System.Data.Objects.DataClasses C# using System.Data.Objects; using System.Data.Objects.DataClasses; </pre> </li> <li>At the top of the partial class definition for the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form, add the following code that creates an ObjectContext<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/ObjectContext&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> instance. <pre> Visual Basic ' Create an ObjectContext instance based on SchoolEntity. Private schoolContext As SchoolEntities C# // Create an ObjectContext instance based on SchoolEntity. private SchoolEntities schoolContext; </pre> </li> <li>In the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form designer, double-click the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form. This opens the code page for the form and creates the courseViewer _Load event handler method. </li> <li>In the courseViewer _Load event handler method, copy and paste the following code that defines the DataGridView<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/DataGridView&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a>, executes a query that returns a collection of departments (ordered by Name), and binds the collection of Department objects to the departmentList control. <pre> Visual Basic ' Initialize the ObjectContext. schoolContext = New SchoolEntities() ' Define a query that returns all Department objects and related ' Course objects, ordered by name. Dim departmentQuery As ObjectQuery(Of Department) = _ schoolContext.Department.Include("Course").OrderBy("it.Name") Try ' Bind the ComboBox control to the query, which is ' executed during data binding. Me.departmentList.DisplayMember = "Name" Me.departmentList.DataSource = departmentQuery Catch ex As Exception MessageBox.Show(ex.Message) End Try C# // Initialize the ObjectContext. schoolContext = new SchoolEntities(); // Define a query that returns all Department objects and related // Course objects, ordered by name. ObjectQuery<Department> departmentQuery = schoolContext.Department.Include("Course").OrderBy("it.Name"); try { // Bind the ComboBox control to the query, which is // executed during data binding. this.departmentList.DisplayMember = "Name"; this.departmentList.DataSource = departmentQuery; } catch (Exception ex) { MessageBox.Show(ex.Message); } </pre> </li> </ol> <h3> <a name="Display courses for the selected department"></a> Display courses for the selected department</h3> <ol> <li>In the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form designer, double-click the departmentList control. This creates the *departmentList_SelectedIndexChanged<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/SelectedIndexChanged&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a>* event handler method. </li> <li>Paste the following code that loads the courses that are related to the selected department. <pre> Visual Basic Try ' Get the object for the selected department. Dim department As Department = _ CType(Me.departmentList.SelectedItem, Department) ' Bind the grid view to the collection of Course objects ' that are related to the selected Department object. courseGridView.DataSource = department.Course ' Hide the columns that are bound to the navigation properties on Course. courseGridView.Columns("Department").Visible = False courseGridView.Columns("CourseGrade").Visible = False courseGridView.Columns("OnlineCourse").Visible = False courseGridView.Columns("OnsiteCourse").Visible = False courseGridView.Columns("Person").Visible = False courseGridView.AutoResizeColumns(DataGridViewAutoSizeColumnsMode.AllCells) Catch ex As Exception MessageBox.Show(ex.Message) End Try C# try { // Get the object for the selected department. Department department = (Department)this.departmentList.SelectedItem; // Bind the grid view to the collection of Course objects // that are related to the selected Department object. courseGridView.DataSource = department.Course; // Hide the columns that are bound to the navigation properties on Course. courseGridView.Columns["Department"].Visible = false; courseGridView.Columns["CourseGrade"].Visible = false; courseGridView.Columns["OnlineCourse"].Visible = false; courseGridView.Columns["OnsiteCourse"].Visible = false; courseGridView.Columns["Person"].Visible = false; courseGridView.AutoResizeColumns(DataGridViewAutoSizeColumnsMode.AllCells); } catch (Exception ex) { MessageBox.Show(ex.Message); } </pre> </li> </ol> <h2> <a name="Inserting and Updating Data"></a> Inserting and Updating Data</h2> In this section the changes made to Course objects bound are saved to the DataGridView<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/DataGridView&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> control to the database and also run the completed Course Manager application. <h3> <a name="Save changes made to objects"></a> Save changes made to objects</h3> <ol> <li>In the Toolbox, expand Common Controls, drag the Button control to the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form designer, change the name of the control to saveChanges, and change the Text value to Update. </li> <li>In the CourseViewer<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/CourseViewer&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> form designer, double-click the saveChanges control. This creates the saveChanges_Click event handler method. </li> <li>Paste the following code that saves object changes to the database. <pre> Visual Basic Try ' Save object changes to the database, display a message, ' and refresh the form. schoolContext.SaveChanges() MessageBox.Show("Changes saved to the database.") Me.Refresh() Catch ex As Exception MessageBox.Show(ex.Message) End Try C# try { // Save object changes to the database, display a message, // and refresh the form. schoolContext.SaveChanges(); MessageBox.Show("Changes saved to the database."); this.Refresh(); } catch (Exception ex) { MessageBox.Show(ex.Message); } </pre> </li> <li>In the closeForm_Click event handler method, type the following code. This code disposes of the object context before the form is closed. <pre> Visual Basic ' Dispose the object context. schoolContext.Dispose() C# // Dispose the object context. schoolContext.Dispose(); </pre> </li> </ol> <h3> <a name="Build and run the Class Scheduling application"></a> Build and run the Class Scheduling application</h3> <ol> <li>From the Debug menu, select Start Debugging or Start Without Debugging, to build and run the application. </li> <li>When the form loads, select a department from the ComboBox<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/ComboBox&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a> control to display the courses that belong to that department. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_18.png" style="wikiautogen" /> </li> <li>In the DataGridView<a href="https://vos.openlinksw.com/dataspace/owiki/wiki/VOS/DataGridView&parent=VirtEntityFrameworkSchoolDbWinFormApp" class="wikiword">?</a>, update course information or add a new course and then click Update to save changes to the database and displays a message box that declares the number of saved changes. <img src="VirtEntityFrameworkSchoolDbWinFormApp/VirtuAdoNetEFApp_19.png" style="wikiautogen" /> </li> </ol> The process is now complete. <Versions></Versions><tags></tags> </div> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"></div> <hr /> <div role="contentinfo" class="contentinfo"> 漏 Copyright <a href="https://www.openlinksw.com/">OpenLink Software </a> 2016- OpenLink Software Documentation Team <virtuoso.docs@openlinksw.com> </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()+'- OpenLink Software Documentation Team <virtuoso.docs@openlinksw.com>') </script>   <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><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>

CINXE.COM