hmLoadTopic({
hmKeywords:"",
hmTitle:"LkProperties Dict Mode",
hmDescription:"Returns the Schema properties list defined in the file dictionaries.",
hmPrevLink:"lk_lkproperties.html",
hmNextLink:"lk_gettable.html",
hmParentLink:"lk_crud-operations.html",
hmBreadCrumbs:"<a href=\"lk_linkarws-operations.html\">LinkarWS Operations<\/a> &gt; <a href=\"lk_crud-operations.html\">CRUD Operations<\/a>",
hmTitlePath:"LinkarWS Operations > CRUD Operations > LkProperties Dict Mode",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">LkProperties Dict Mode<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_Normal\">Returns the Schema properties list defined in the file dictionaries.<\/p>\n\r<p class=\"p_Normal\">This version of LkProperties is used to obtain a list of Properties of the DICTIONARIES schema type.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-weight: bold;\">GET<\/span>: api\/v1\/<span style=\"font-weight: bold;\">&lt;apiresource&gt;<\/span>\/crud\/LkProperties\/Dictionaries\/<span style=\"font-weight: bold;\">&lt;filename&gt;<\/span><\/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;\">&lt;apiresource&gt;<\/span> ApiResource name. e.g. <span style=\"font-style: italic;\">apidemo<\/span>.<br \/>\n\r<span style=\"font-style: italic;\">&nbsp;<\/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;\">&lt;filename&gt;<\/span> Name of the file on which the operation is performed. e.g. <span style=\"font-style: italic;\">LK.CUSTOMERS<\/span><br \/>\n\r<span style=\"font-style: italic;\">e.g. api\/v1\/<\/span><span style=\"font-style: italic; font-weight: bold;\">apidemo<\/span><span style=\"font-style: italic;\">\/crud\/<\/span>LkProperties<span style=\"font-style: italic;\">\/Dictionaries\/<\/span><span style=\"font-style: italic; font-weight: bold;\">LK.CUSTOMERS<\/span><\/p><p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-size: 1.09rem; font-weight: bold;\">Parameters<\/span><\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<div style=\"text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;\"><table class=\"argumentos\" >\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem;\"><p class=\"p_Normal\">row_properties<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem;\"><p class=\"p_Normal\">boolean<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem;\"><p class=\"p_Normal\">First row contains property names.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">only_visibles<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">boolean<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Use only Visible Schemas and Properties.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem;\"><p class=\"p_Normal\">use_property_names<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem;\"><p class=\"p_Normal\">boolean<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem;\"><p class=\"p_Normal\">Use Properties and Table names.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">row_headers<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">string<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">Include headings in first row MAINLABEL (main headings), SHORTLABEL (short label headings), and NONE (without headings).<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem;\"><p class=\"p_Normal\">pagination<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem;\"><p class=\"p_Normal\">boolean<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem;\"><p class=\"p_Normal\">Indicates if pagination is being used or not.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">reg_page<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">integer<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">In case of pagination it indicates the page number to obtain. Must be greater than 0.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem;\"><p class=\"p_Normal\">num_page<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem;\"><p class=\"p_Normal\">integer<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem;\"><p class=\"p_Normal\">In case of pagination it indicates the page number to obtain. Must be greater than 0.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">custom_vars<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">string<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem; background-color:#CCFFFF;\"><p class=\"p_Normal\">This is a free text field to send in the transaction. If not empty, subroutine SUB.LK.MAIN.CONTROL.CUSTOM will be called. Add custom code to that subroutine to define special behaviours for some or all transactions.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"width:13.8125rem;\"><p class=\"p_Normal\">svr_timeout<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:5.8750rem;\"><p class=\"p_Normal\">integer<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"width:49.3125rem;\"><p class=\"p_Normal\">This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\"><span style=\"font-size: 0.91rem; font-style: italic;\">(*) Mandatory<\/span><\/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-size: 1.09rem; font-weight: bold;\">Request Body<\/span><\/p>\n\r<p class=\"p_Normal\">Unused<\/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<p class=\"p_Normal\"><span style=\"font-size: 1.09rem; font-weight: bold;\">Responses<\/span><\/p>\n\r<p class=\"p_Normal\">On all kind of responses, an <span style=\"font-style: italic;\">ERROR<\/span> tag will list all possible errors during execution of the operation. This tag includes <span style=\"font-style: italic;\">CODE<\/span> tag with the error codes and <span style=\"font-style: italic;\">MESSAGE<\/span> tag with messages of each error.<\/p>\n\r<p class=\"p_Normal\">In responses of type &quot;text\/plain&quot; (LkString MV), error codes and messages are separated by multivalue marks.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic; font-weight: bold;\">application\/json<\/span><\/p>\n\r<p class=\"p_Normal\">This image shows an example of running an operation in the <span style=\"font-style: italic;\">LK.CUSTOMERS <\/span>file. &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><img style=\"margin:0;width:21.3750rem;height:30.0000rem;border:none\" src=\".\/images\/json_response_example.png\"\/><\/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-style: italic; font-weight: bold;\">application\/xml<\/span><\/p>\n\r<p class=\"p_Normal\">This image shows an example of running an operation in the <span style=\"font-style: italic;\">LK.CUSTOMERS <\/span>file. &nbsp; &nbsp; &nbsp; <\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><img style=\"margin:0;width:21.4375rem;height:30.0000rem;border:none\" src=\".\/images\/xml_response_example.png\"\/> &nbsp; &nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic;\"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <\/span><\/p>\n\r<p class=\"p_Normal\"><span style=\"font-style: italic; font-weight: bold;\">text\/plain<\/span><\/p>\n\r<p class=\"p_Normal\">This image shows an example of running an operation in the <span style=\"font-style: italic;\">LK.CUSTOMERS <\/span>file with the default options.<\/p>\n\r<p class=\"p_Normal\">This response is a chain of characters structured in sections, named &quot;LkString&quot;.<\/p>\n\r<p class=\"p_Normal\">For more information about the different tags in this response, <a href=\"lk_text_plain.html\" class=\"topiclink\">click here<\/a>.<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p class=\"p_Normal\"><img style=\"margin:0;width:25.0000rem;height:30.0000rem;border:none\" src=\".\/images\/text_response_example2.png\"\/><\/p>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r"
})
