Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReportsApi

Hierarchy

  • ReportsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://api-na.myconnectwise.net/v4_6_release/apis/3.0"

defaultHeaders

defaultHeaders: any

Methods

systemReportsGet

  • systemReportsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<Report>>

  • Get Reports

    Parameters

    • params: object
      • Optional childconditions?: string
      • Optional conditions?: string
      • Optional customfieldconditions?: string
      • Optional orderBy?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<Report>>

systemReportsReportNameColumnsGet

  • systemReportsReportNameColumnsGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Array<JObject>>

  • Get Column Definitions

    Parameters

    • params: object
      • reportName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Array<JObject>>

systemReportsReportNameCountGet

  • systemReportsReportNameCountGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Count>

  • Get Report Results Count

    Parameters

    • params: object
      • Optional conditions?: string
      • reportName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Count>

systemReportsReportNameGet

  • systemReportsReportNameGet(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ReportDataResponse>

  • Get Report Results

    Parameters

    • params: object
      • Optional childconditions?: string
      • Optional columns?: string
      • Optional conditions?: string
      • Optional customfieldconditions?: string
      • Optional orderBy?: string
      • Optional page?: number
      • Optional pageSize?: number
      • reportName: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ReportDataResponse>

Generated using TypeDoc