Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReportTasksApi

ReportTasksApi - object-oriented interface

export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createReportTask

  • summary

    Create report task

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    Returns Promise<AxiosResponse<ReportTaskResponse>>

deleteReportTask

  • deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<AxiosResponse<void>>

  • Delete a report task by its ID

    summary

    Delete report task

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    • id: string
    • Optional deleteAssociatedReports: boolean
    • Optional options: any

    Returns Promise<AxiosResponse<void>>

getReportTask

  • Read a report task by its ID

    summary

    Read report task

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<ReportTaskResponse>>

getReportTasks

  • getReportTasks(pageNum?: number, meta?: {}, templateId?: string, perPage?: number, orderBy?: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId", order?: "asc" | "desc", filter?: object, options?: any): Promise<AxiosResponse<InlineResponse2002>>
  • summary

    List report tasks

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    • Optional pageNum: number
    • Optional meta: {}
      • [key: string]: string
    • Optional templateId: string
    • Optional perPage: number
    • Optional orderBy: "title" | "startOn" | "endOn" | "enabled" | "username" | "frequency" | "scheduledJobs.lastFinishedAt" | "scheduledJobs.nextRunAt" | "scheduledJobs.lastRunAt" | "averageTimeToGenerate" | "id" | "templateId"
    • Optional order: "asc" | "desc"
    • Optional filter: object
    • Optional options: any

    Returns Promise<AxiosResponse<InlineResponse2002>>

runReportTaskNow

  • Duplicates the task and runs it as "Once - Now"

    summary

    Run task now

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<ReportTaskResponse>>

updateReportTask

  • Accepts partial updates

    summary

    Update report task by ID

    throws

    {RequiredError}

    memberof

    ReportTasksApi

    Parameters

    Returns Promise<AxiosResponse<ReportTaskResponse>>

Generated using TypeDoc