@mbanq/core-sdk-js v0.50.0

---

@mbanq/core-sdk-js / commands / GetReports

Function: GetReports()

GetReports(data): Command<{ data: { genericResultSet: boolean; parameterType: boolean; }; }, object[] | { columnHeaders: object[]; data: object[]; metaData: { count: number; message: string; outputMethodDerived: string; }; }>

Defined in: src/commands/rest/report.ts:36

Retrieves a list of available reports based on parameter type and result set format.

Parameters

data

The request parameters for fetching reports

genericResultSet

boolean = ...

Whether to return generic result sets. Response format depends on this flag: true returns GetReportsGenericResponse, false returns GetReportsResponse

parameterType

boolean = ...

The type of parameters to filter reports by

Returns

Command<{ data: { genericResultSet: boolean; parameterType: boolean; }; }, object[] | { columnHeaders: object[]; data: object[]; metaData: { count: number; message: string; outputMethodDerived: string; }; }>

A command that fetches the list of available reports. Response type is GetReportsGenericResponse if genericResultSet is true, otherwise GetReportsResponse

Example

const command = GetReports({
  parameterType: true,
  genericResultSet: false
});
const reports = await client.request(command);