Please enable JavaScript to view this site.

Allows execution of any command in the database.

 

GET: api/v1/<apiresource>/Execute/{statement}

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

{name} Parameter

Example: api/v1/apidemo/Subroutine/SUB.DEMOLINKAR/

 

 

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

name (*)

string

Name of BASIC subroutine to execute.

(*) 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

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.