Function getReportFileByName

  • getReportFileByName<Result>(name, namespaces?, responseType?, ext?): Promise<ResponseTypeMap[Result]>

  • Get report main file (the result) by giving the report's name

    Needs namespaces[namespaceId].reports-get-year-yearMonth-filename permission

    Type Parameters

    • Result extends keyof ResponseTypeMap = "text"

    Parameters

    • name: string

      Name of the report

    • Optional namespaces: string[]
    • Optional responseType: Result

      Wanted response type

    • ext: string = 'pdf'

      The extension of the result (renderer dependent)

    Returns Promise<ResponseTypeMap[Result]>

    The report's content

Settings

Member Visibility

Theme

Generated using TypeDoc