hmLoadTopic({
hmKeywords:"",
hmTitle:"LinkarWS Operations",
hmDescription:"On LinkarWS Manager section \"Swagger Publisher\", it is possible to generate a JSON file with EndPoints to run LinkarServer operations.",
hmPrevLink:"ws_docker.html",
hmNextLink:"lk_crud-operations.html",
hmParentLink:"index.html",
hmBreadCrumbs:"",
hmTitlePath:"LinkarWS Operations",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">LinkarWS Operations<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_Normal\">On LinkarWS Manager section &quot;Swagger Publisher&quot;, it is possible to generate a JSON file with EndPoints to run LinkarServer operations.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">LinkarWS runs these operations using Linkar Framework libraries. Once EndPoints are defined, LinkarWS is capable of running the following operations groups:<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_crud-operations.html\" class=\"topiclink\">CRUD Operations<\/a><\/p>\n\r<p class=\"p_Normal\">EndPoints that allow execution of Read, Update, New, Delete and Select operations on Database files.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_function-operations.html\" class=\"topiclink\">Function Operations<\/a><\/p>\n\r<p class=\"p_Normal\">EndPoints that allow execution of different types of operations such as Subroutine, Conversion, LkSchemas...<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_sendcommand-operations.html\" class=\"topiclink\">SendCommand Operations<\/a><\/p>\n\r<p class=\"p_Normal\">EndPoints created for these operations are POST type and allow execution of all kind of Crud operations and Functions using different available templates in the request body.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_custom-operations.html\" class=\"topiclink\">Custom Operations<\/a><\/p>\n\r<p class=\"p_Normal\">Special EndPoints, similar to SendCommand Operation ones, with fully customizable input and ouput data. <\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_admin-operations.html\" class=\"topiclink\">Admin Operations<\/a><\/p>\n\r<p class=\"p_Normal\">Special EndPoints, e.g. check if LinkarWS is active.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_user-operations.html\" class=\"topiclink\">User Operations<\/a><\/p>\n\r<p class=\"p_Normal\">Special EndPoints available only when LinkarWS is set on OAuth 2.0 authentication mode and are used for new users automatic registration and password changes.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">API Resources can be generated on <a href=\"ws_manager.html\" class=\"topiclink\">LinkarWS Manager<\/a> and their scopes define available files and operations.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-weight: bold;\">Swagger URL Example<\/span><\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">URL to access Swagger have the folllowing structure: <\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic;\"><a href=\"http:\/\/localhost:12000\/swagger\/index.html?api_resource=apidemo\" target=\"_blank\" class=\"weblink\">http:\/\/localhost:12000\/swagger\/index.html?api_resource=apidemo<\/a><\/span><\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>&quot;<span style=\"font-weight: bold;\">localhost<\/span>&quot;, can be an IP or a DNS name that LinkarWS listens to. Default listening port is 12000.<\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span>&quot;<span style=\"font-weight: bold;\">apidemo<\/span>&quot;, name of the JSON file located in wwwroot\/swagger\/docs (inside LinkarWS installation folder). This file is created from LinkarWS Manager\'s<span style=\"font-style: italic;\"> Swagger Publisher<\/span> section. By default, the file name is the ApiResource or ApiKey name and can be changed by the user.<\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><a href=\"lk_response-types.html\" class=\"topiclink\">Response Types and HTTP status code<\/a><\/p>\n\r<p class=\"p_Normal\">Usually, &nbsp;all EndPoints have 3 possible response types:<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span><span style=\"font-style: italic;\">application\/json<\/span><\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span><span style=\"font-style: italic;\">application\/xml<\/span><\/p><p class=\"p_Normal\" style=\"text-indent: 0; padding-left: 0.8125rem; margin-left: 0;\"><span class=\"f_Normal\" style=\"font-family: Arial,\'Lucida Sans Unicode\',\'Lucida Grande\',\'Lucida Sans\';display:inline-block;width:0.8125rem;margin-left:-0.8125rem\">&#8226;<\/span><span style=\"font-style: italic;\">text\/plain<\/span><\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic;\">“application\/json” and “application\/xml” <\/span>types are almost self-explanatory. Anyways, <a href=\"lk_response-types.html\" class=\"topiclink\">this section<\/a> contains &nbsp;the different tags that can be part of this responses.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic;\">&quot;text\/plain&quot; <\/span>is more complex. Its a structured chain of characters, containing tags and sections as well. This chain of characters is literally what LinkarServer returns as a result of the executed operations. On LinkarServer context, this chain of characters is named &quot;<span style=\"font-style: italic;\">LkString<\/span>&quot;. Find more information on &quot;text\/plain (LkString MV)&quot; <a href=\"lk_text_plain.html\" class=\"topiclink\">section<\/a>.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r"
})
