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).

Example

Get all open problems

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

Example

Get high-priority unresolved problems with pagination

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

Example

Get problems for a specific type and user

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

Example

Get problems related to a specific limeobject

const dealProblems = await provider.getProblems({
    context: {
        limetype: 'deal',
        id: 98765
    }
});

See

Hierarchy

  • ProblemQueryOptions

Properties

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

Properties

Optional context

context?: ProblemContextFilter

Filter by related LimeObject.

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

See

Optional limit

limit?: number

Maximum number of problems to return.

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

Optional offset

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 }.

Optional severity

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.

See

ProblemSeverity

Optional status

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.

See

status

Optional tags

tags?: string[]

Filter by tag(s).

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

See

tags

Optional type

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.

See

type

Optional userId

userId?: string

Filter by user identifier.

Returns problems associated with the specified user.

See

userId

Settings

Member Visibility

Theme