Type Alias APIError

An error object

type APIError = {
    code: string;
    detail?: string;
    meta?: {
        argument?: string;
        details?: string;
        errorId?: string;
        issue?: string;
        resource?: string;
        resourceId?: string;
    };
    title: string;
}
Index

Properties

code detail? meta? title

Properties

code: string

Qlik error code (not HTTP response status code)

detail?: string

Description of the error

meta?: {
    argument?: string;
    details?: string;
    errorId?: string;
    issue?: string;
    resource?: string;
    resourceId?: string;
}

Additional details about the error. These may vary by error.

Type declaration

  • Optionalargument?: string

    The argument

  • Optionaldetails?: string

    Extra details for what may have caused the error

  • OptionalerrorId?: string

    The unique id of the error instance

  • Optionalissue?: string

    The issue code

  • Optionalresource?: string

    The resource type that the error occurred on

  • OptionalresourceId?: string

    The resource id that the error occurred on

title: string

Short summary of error

Settings

Member Visibility

On This Page

Properties