Function startGeneration

  • startGeneration(taskOrId, params?, namespaces?): Promise<ApiResponse<ReportJob>>

  • Start generation of a report

    Needs namespaces[namespaceId].tasks-post-task-_run permission

    Parameters

    • taskOrId: string | RawFullTask

      Task or id of the task

    • Optional params: {
          period?: Period;
          testEmails?: string[];
      }

      Other params for overriding default

      • Optional period?: Period

        Override period, must match task's recurrence

      • Optional testEmails?: string[]

        Override targets of task. Also enable first level of debugging (disable generation history)

    • Optional namespaces: string[]

    Returns Promise<ApiResponse<ReportJob>>

    Job info to track progress

Settings

Member Visibility

Theme

Generated using TypeDoc