Interface IncidentsApiSearchIncidentsRequest

Hierarchy

  • IncidentsApiSearchIncidentsRequest

Properties

include? pageOffset? pageSize? query sort?

Properties

Optional include

include?: IncidentRelatedObject

Specifies which types of related objects should be included in the response.

Optional pageOffset

pageOffset?: number

Specific offset to use as the beginning of the returned page.

Optional pageSize

pageSize?: number

Size for a given page. The maximum allowed value is 100.

query

query: string

Specifies which incidents should be returned. The query can contain any number of incident facets joined by ANDs, along with multiple values for each of those facets joined by ORs. For example: state:active AND severity:(SEV-2 OR SEV-1).

Optional sort

sort?: IncidentSearchSortOrder

Specifies the order of returned incidents.

Settings

Member Visibility

Theme

Generated using TypeDoc