Returns a list of all Schemas defined in Linkar Schemas or from the MV account associated with the current EntryPoint. This version of LkSchemas is used to obtain LKSCHEMAS type schemas.
GET: api/v1/<apiresource>/LkSchemas
•<apiresource>ApiResource name. e.g. apidemo.
Example: api/v1/apidemo/LkSchemas
Parameters
row_properties |
boolean |
First row contains property names. |
only_visibles |
boolean |
Use only Visible Schemas and Properties. |
row_headers |
string |
Include headings in first row MAINLABEL (main headings), SHORTLABEL (short label headings), and NONE (without headings). |
pagination |
boolean |
In case of pagination it indicates the page number to obtain. Must be greater than 0. |
reg_page |
integer |
In case of pagination it indicates the page number to obtain. Must be greater than 0. |
num_page |
integer |
In case of pagination indicates the number of records by page. It must be bigger than 0. |
custom_vars |
string |
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 behaviors for some or all transactions. |
svr_timeout |
integer |
This is the maximum time in seconds that the client will wait for a response. Use 0 for no timeout. |
(*) Mandatory
Request Body
Unused
Responses
Each of the information items received from GetVersion are displayed as if they were attributes of a record.
On all kind of responses, an ERROR tag will list all possible errors during execution of the operation. This tag includes CODE tag with the error codes and MESSAGE tag with messages of each error.
In responses of type "text/plain" (LkString MV), error codes and messages are separated by multivalue marks.
application/json
The response will be displayed in JSON format.
For more information about the different tags in this response, click here.
application/xml
The response will be displayed in XML format.
For more information about the different tags in this response, click here.
text/plain
The response will be displayed in TEXT format.
This response is a chain of characters structured in sections, named "LkString".
For more information about the different tags in this response, click here.
