Type alias CustomReport

CustomReport: {
    _isGenerated?: boolean;
    adminOnly?: boolean;
    display?: boolean;
    displayParams?: CustomReportDisplayParams;
    id: string;
    noDownload?: boolean;
    params?: Record<string, unknown>;
    queryType?: "shortIds";
    rangeType?: "scans" | "cases";
    title: string;
} & {
    columns?: CustomReportColumn[];
    queryParams?: {
        [paramName: string]: string;
    };
}

Type declaration

  • Optional _isGenerated?: boolean

    used by addons to identify stuff to regenerate

  • Optional adminOnly?: boolean

    do not serve this report to regular users (checked on server)

  • Optional display?: boolean

    display this report (using column formats from api) after loading it

  • Optional displayParams?: CustomReportDisplayParams

    display settings used client-side

  • id: string

    the stored proc name (without the custom_report_ prefix), or an arbitrary id for query-based reports

  • Optional noDownload?: boolean

    do not add a button to download raw data

  • Optional params?: Record<string, unknown>

    optional params to send to the custom report query. currently requires the stored proc name to end with _with_params (not used by searchcases() queries)

  • Optional queryType?: "shortIds"

    interpreted by search-based reports

  • Optional rangeType?: "scans" | "cases"

    forwarded to search buttons on the report, and interpreted by search-based reports

  • title: string

    Used in the UI

Type declaration

  • Optional columns?: CustomReportColumn[]
  • Optional queryParams?: {
        [paramName: string]: string;
    }

    params passed to searchcases() and friends; auth and range params are implicit

    • [paramName: string]: string

Settings

Member Visibility

Theme