Returns the result of executing the FMT function on an expression list in the database.
GET: api/v1/<apiresource>/Format/{format}/{expression}
•<apiresource>ApiResource name. e.g. apidemo.
•{format} Parameter
•{expression} Parameter
Example: api/v1/apidemo/Format/R#10/1þ2/
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. |
format (*) |
string |
Specified format. |
expression (*) |
string |
The data or expression to format. If multiple values are present, the operation will be performed individually on all values in the expression. |
(*) 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 image below shows an example of the result of executing the operation with "R#10 -" as "format" and "1þ2" as "expression".
application/xml
The image below shows an example of the result of executing the operation with "R#10 -" as "format" and "1þ2" as "expression".
text/plain
The image below shows an example of the result of executing the operation with "R#10 -" as "format" and "1þ2" as "expression".
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.
