API Input Request Fields

This field can have three possible values.

API001 – For APIs that will retrieve single record.

API002 – For APIs that will retrieve multiple records.

API003 – For APIs that will retrieve multiple records returning data in a hexadecimal format.

Note, internally tableBASE RESTConnector uses a tableBASE table called APICONFG which has all the default values for API001, API002, and API003 type APIs. This table has details like what should be the corresponding tableBASE command used by the API interface and default values used in the COMMAND-AREA used to make internal tableBASE API calls.

Additional records can be added to this table APICONFG to design more complex APIs and pass more API specific COMMAND-AREA values. More details about APICONFG table can be found in tableBASE Installation Guide.

Name of the tableBASE table that holds the data to be exposed as API.

In the DK1TEXEC example, the name of the table is EXMPCAT.

This is the name of the VTS-TSR the table is loaded into. In the example given, the name of the VTS-TSR is VTS2

This is used only with Multiple record retrieval.

This is the number of records to skip from the retrieved records.

Value for this field can be mapped as one of the path parameter in the HTTP GET request.