@inetsoft/api-client
Options
All
  • Public
  • Public/Protected
  • All
Menu

ReportApi provides operations used to execute reports.

Hierarchy

  • ReportApi

Index

Methods

Methods

closeReport

  • closeReport(id: string): Promise<void>

deployReport

  • deployReport(file: ArrayBuffer, name: string, alias: string, description: string, folder: string, visible: boolean, bursting: boolean, pregenerated: boolean, cycle: string | null, overwrite: boolean, exportFormats: string[], parameters: ReportParameter[], permissions: PermissionGrant[]): Promise<void>

  • Deploys a report to the repository.

    Parameters

    • file: ArrayBuffer

      the binary content of the template file.

    • name: string

      the name of the deployed report.

    • alias: string

      the alias for the report.

    • description: string

      a description of the report.

    • folder: string

      the path to the parent folder of the report.

    • visible: boolean

      a flag that indicates if the report is visible in the repository tree.

    • bursting: boolean

      a flag that indicates if bursting is enabled for the report.

    • pregenerated: boolean

      a flag that indicates if the report is pre-generated.

    • cycle: string | null

      the name of the cycle to be used to pre-generate the report.

    • overwrite: boolean

      a flag that indicates if an existing report should be overwritten.

    • exportFormats: string[]

      the list of export formats that are allowed for the report.

    • parameters: ReportParameter[]

      the initialization and creation parameters for the report.

    • permissions: PermissionGrant[]

      the permissions granted on the report.

    Returns Promise<void>

executeReport

  • executeReport(id: string, parameters: object): Promise<void>

  • Executes an opened report.

    Parameters

    • id: string

      the identifier of the opened report.

    • parameters: object

      the parameters to use when executing the report.

      • [name: string]: any

    Returns Promise<void>

exportReport

  • exportReport(id: string, format: string): Promise<ArrayBuffer>

  • Exports an opened report.

    Parameters

    • id: string

      the identifier of the opened report.

    • format: string

      the file format for the exported report.

    Returns Promise<ArrayBuffer>

    the binary content of the exported report.

getOpenReports

  • getOpenReports(): Promise<Report[]>

getOpenedReport

  • getOpenedReport(id: string): Promise<Report>

  • Gets information about an opened report.

    Parameters

    • id: string

      the identifier of the opened report.

    Returns Promise<Report>

    the opened report.

getReportPageCount

  • getReportPageCount(id: string): Promise<number>

  • Gets the number of pages in a report.

    Parameters

    • id: string

      the identifier of the opened report.

    Returns Promise<number>

    the number of pages in the specified report.

getReports

  • getReports(): Promise<Report[]>

mailReport

  • mailReport(id: string, recipients: string[], sender: string, subject: string, message: string, format: string): Promise<void>

  • Sends an opened report in an email message.

    Parameters

    • id: string

      the identifier of the opened report.

    • recipients: string[]

      the email addresses of the recipients of the message.

    • sender: string

      the email address of the sender of the message.

    • subject: string

      the subject line of the message.

    • message: string

      the body of the email message.

    • format: string

      the file format for the attached report.

    Returns Promise<void>

openReport

  • openReport(path: string, execute: boolean, parameters: object): Promise<Report>

  • Opens a report.

    Parameters

    • path: string

      the path to the report to open.

    • execute: boolean

      true to immediately execute the report; false otherwise. If false, a subsequent call to executeReport() is required.

    • parameters: object

      the parameters to use when opening the report.

      • [name: string]: any

    Returns Promise<Report>

    the opened report.

printReport

  • printReport(id: string, printer: string, pages: number[]): Promise<void>

  • Prints an opened report on the server.

    Parameters

    • id: string

      the identifier of the opened report.

    • printer: string

      the name of the server printer.

    • pages: number[]

      the page numbers to print.

    Returns Promise<void>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc