search string
side menu
ReportSchemeService

#Service for retrieving report information

Allows retrieving information about the reports available in the system.

Hierarchy

  • ReportSchemeService

Methods

get

  • get(namespace: string, code: string): Promise<ReportScheme | undefined>

  • Retrieve report information by its code and workspace.

    Parameters

    • namespace: string
    • code: string

    Returns Promise<ReportScheme | undefined>

    Object containing report informationе. 

    const reportScheme =  await System.scheme.report.get('crm', 'sales_report');

list

  • list(namespace: string): Promise<readonly BaseReportScheme[]>

  • Retrieve a list of reports within a workspace.

    Parameters

    • namespace: string

    Returns Promise<readonly BaseReportScheme[]>

    Array of objects containing report information. 

    const  reports = await System.scheme.report.list('crm');