Please enable JavaScript to view this site.

Returns all dictionary definitions from a file.

 

GET: api/v1/<apiresource>/crud/<filename>

 

<apiresource> ApiResource name. e.g. apidemo.
 

<filename> Name of the file on which the operation is performed. e.g. LK.CUSTOMERS
e.g. api/v1/apidemo/crud/dictionaries/LK.CUSTOMERS/

 

 

 

Parameters

 

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 behaviours 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

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

This image shows an example of running an operation in the LK.CUSTOMERS file.                          

 

 

 

application/xml

This image shows an example of running an operation in the LK.CUSTOMERS file.      

 

   

 

                                         

text/plain

This image shows an example of running an operation in the LK.CUSTOMERS file.