Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface ProblemQueryOptionsAlpha

    Options for querying problems from a ProblemProvider.

    All filter properties are optional. Providers handle what they support and silently ignore unsupported filters. This allows the platform to pass a consistent set of filters without needing to know each provider's capabilities.

    Multiple values can be provided for most filters (severity, status, type, tags) to match problems that have any of the specified values (OR logic).

    Get all open problems

    const openProblems = await provider.getProblems({
        status: 'open'
    });

    Get high-priority unresolved problems with pagination

    const urgentProblems = await provider.getProblems({
        severity: [ProblemSeverity.High, ProblemSeverity.Critical],
        status: ['open', 'acknowledged'],
        limit: 20,
        offset: 0
    });

    Get problems for a specific type and user

    const userEmailProblems = await provider.getProblems({
        type: 'email.delivery-failed',
        userId: 'user-123'
    });

    Get problems related to a specific limeobject

    const dealProblems = await provider.getProblems({
        context: {
            limetype: 'deal',
            id: 98765
        }
    });
    interface ProblemQueryOptions {
        context?: ProblemContextFilter;
        limit?: number;
        offset?: number;
        severity?: ProblemSeverity | ProblemSeverity[];
        status?: string | string[];
        tags?: string[];
        type?: string | string[];
        userId?: string;
    }
    Index

    Properties

    context? limit? offset? severity? status? tags? type? userId?

    Properties

    context?: ProblemContextFilter

    Filter by related LimeObject.

    Use this to find problems linked to a specific limetype or object instance.

    limit?: number

    Maximum number of problems to return.

    Used for pagination. When omitted, the provider decides the default limit.

    offset?: number

    Number of problems to skip before returning results.

    Used for pagination in combination with limit. For example, to get the second page of 20 items, use { limit: 20, offset: 20 }.

    severity?: ProblemSeverity | ProblemSeverity[]

    Filter by severity level(s).

    When a single value is provided, returns problems with that severity. When an array is provided, returns problems matching any of the severities.

    ProblemSeverity

    status?: string | string[]

    Filter by status(es).

    Status values are provider-defined strings. When a single value is provided, returns problems with that status. When an array is provided, returns problems matching any of the statuses.

    Problem.status

    tags?: string[]

    Filter by tag(s).

    Returns problems that have any of the specified tags (OR logic).

    Problem.tags

    type?: string | string[]

    Filter by problem type(s).

    Types are provider-specific strings like 'email.delivery-failed' or 'sync.connection-error'. When an array is provided, returns problems matching any of the types.

    Problem."type"

    userId?: string

    Filter by user identifier.

    Returns problems associated with the specified user.

    Problem.userId

    Settings

    Member Visibility

    On This Page

    Properties