Interface IReport

interface IReport {
    reasons: {
        exportErrors: IExportError[];
        outputId: string;
        traceId: string;
    }[];
    resolutionAttempts: number;
    results: {
        exportErrors: IExportError[];
        location: string;
        outputId: string;
    }[];
    status: "failed" | "done" | "aborted" | "queued" | "processing" | "visiting" | "aborting";
    statusLocation: string;
}

Properties

reasons resolutionAttempts results status statusLocation

Properties

reasons

reasons: {
    exportErrors: IExportError[];
    outputId: string;
    traceId: string;
}[]

Present when status is failed

Type declaration

  • exportErrors: IExportError[]

    Errors occurred during report generation

  • outputId: string

    The output identifier which uniquely identifies an output (PDF, image etc.) within the same request.

  • traceId: string

resolutionAttempts

resolutionAttempts: number

Count how many times the resolution of this report was attempted.

results

results: {
    exportErrors: IExportError[];
    location: string;
    outputId: string;
}[]

Present when the status is "done"

Type declaration

  • exportErrors: IExportError[]

    Errors occurred during report generation

  • location: string

    Location to download the generated report.

  • outputId: string

    The output identifier which uniquely identifies an output (PDF, image etc.) within the same request

status

status: "failed" | "done" | "aborted" | "queued" | "processing" | "visiting" | "aborting"

Status of the requested report

statusLocation

statusLocation: string

Relative path to status location

Settings

Member Visibility

Theme

On This Page