@mbanq/core-sdk-js v0.50.0

---

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

Function: GetReportParameters()

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

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

Retrieves the parameters required for running a specific report.

Parameters

data

The request parameters for fetching report parameters

genericResultSet

boolean = ...

Whether to use generic result sets. Response format depends on this flag: true returns GetReportParametersGenericResponse, false returns GetReportParametersResponse

parameterType

boolean = ...

The type of parameters for the report

R_reportListing

string = ...

The report listing identifier

Returns

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

A command that fetches the parameters for a specific report. Response type is GetReportParametersGenericResponse if genericResultSet is true, otherwise GetReportParametersResponse

Throws

If the request fails or validation fails

Example

const command = GetReportParameters({
  parameterType: 'all',
  genericResultSet: false,
  R_reportListing: 'Client Listing'
});
const parameters = await client.request(command);