Class Report

appConfig

auth

getQueryList

• getQueryList(
      pageNumber?: number,
      perPage?: number,
      filters?: ReportListFilters,
  ): Promise<ReportListResults>

  Retrieves the system report list

  Parameters

  • pageNumber: number = 0

    The current page number as a zero-based value
  • perPage: number = 50

    The total number of reports per page
  • Optionalfilters: ReportListFilters

    The object that is used to filter the result set

  Returns Promise<ReportListResults>

  A ReportListResults object with the report details

  Remarks

  An async function that returns the results of system reports. The authenticated user must have access to system reports to view this data.

  Throws

  Error if the query list could not be retrieved. This is caused by connectivity, session or user permission issues.

getReportData

• getReportData(
      templateId: number,
      pageNumber?: number,
      pageSize?: number,
  ): Promise<ReportData>

  Returns the report data for a specific page.

  Parameters

  • templateId: number

    The unique report ID
  • pageNumber: number = 0

    The current page number
  • pageSize: number = 50

    The page size

  Returns Promise<ReportData>

  A ReportData object containing record details for the current page.

  Remarks

  This method is used to retrieve data from a specific report. It will return an object that contains the data with the defined columns.

  Throws

  Error if the input is invalid or if the client encounters connectivity issues.

getReportDefinition

• getReportDefinition(templateId: number): Promise<ReportMetadata>

  Retrieves the report metadata

  Parameters

  • templateId: number

    The unique report ID

  Returns Promise<ReportMetadata>

  A ReportMetadata object

  Remarks

  The report metadata will contain details surrounding the columns.

  Throws

  Error if the report is not found or if the client encounters connectivity issues.