@mbanq/core-sdk-js / commands / GetEntriesFromDataTable
Function: GetEntriesFromDataTable()
GetEntriesFromDataTable(
params):Command<{params: {apptableid:number;datatable:string;genericResultSet?:boolean;mask?:boolean;order?:string; }; }, {columnHeaders:object[];data:object[];datatableDisplayName:string;sections:object[]; }>
Defined in: src/commands/rest/dataTable.ts:153
Get all entries from a data table
This API retrieves all entries from the specified data table. It allows you to access comprehensive information stored in the data table, including metadata such as column headers, column types, and section details.
Use this to fetch both the data and structure of the table for reporting, analysis, or integration with other systems. Ideal for applications that need to display or process tabular data dynamically.
Parameters
params
The path and query parameters
apptableid
number = ...
The ID of the application table (defaults to 101 for client tables)
datatable
string = ...
The name of the data table (e.g., 'd_testdatatable')
genericResultSet?
boolean = ...
Controls the response format (true for generic resultset, false for simplified JSON)
mask?
boolean = ...
Controls whether sensitive data should be masked (defaults to true)
order?
string = ...
Optional sort order for the results (e.g., 'DESC')
Returns
Command<{ params: { apptableid: number; datatable: string; genericResultSet?: boolean; mask?: boolean; order?: string; }; }, { columnHeaders: object[]; data: object[]; datatableDisplayName: string; sections: object[]; }>
Command object that executes the API request and returns the data table entries with metadata
Example
const command = GetEntriesFromDataTable({
datatable: 'd_testdatatable',
apptableid: 517,
mask: true,
genericResultSet: true
});
const result = await client.request(command);
console.log(result.datatableDisplayName); // 'Test Data Table'
console.log(result.columnHeaders.length); // 4
console.log(result.data[0].row); // ['1651719413544', '517', '1200', null]