Maximo API Client - v0.9.21
    Preparing search index...

    Interface GenerateReportOptions

    Options for generating a BIRT report.

    interface GenerateReportOptions {
        format?: string;
        where?: string;
        attachment?: boolean;
        parameters?: Record<string, string | number | boolean>;
        responseType?: "arraybuffer" | "blob" | "stream";
    }
    Index

    Properties

    format? where? attachment? parameters? responseType?

    Properties

    format?: string

    Output format. Defaults to 'pdf'.

    where?: string

    OSLC where clause used to filter the set of MBOs included in the report. Example: wonum="1000"

    attachment?: boolean

    When true, the server will include attachments in the generated report by adding attachment=1 to the request.

    parameters?: Record<string, string | number | boolean>

    Report-specific parameters passed as additional query parameters.

    responseType?: "arraybuffer" | "blob" | "stream"

    Axios response type. Defaults to 'arraybuffer'.

    Settings

    Member Visibility

    On This Page

    Properties