EventSearchRequest | Operations for Applications REST API

EventSearchRequest

JSON Example

{
    "cursor": "string",
    "limit": 100,
    "query": [
        {
            "key": "string",
            "value": "string",
            "values": [
                "string"
            ],
            "matchingMethod": "string",
            "negated": false,
            "start": 0,
            "end": 0
        }
    ],
    "timeRange": {
        "earliestStartTimeEpochMillis": 0,
        "latestStartTimeEpochMillis": 0
    },
    "relatedEventTimeRange": {
        "earliestStartTimeEpochMillis": 0,
        "latestStartTimeEpochMillis": 0
    },
    "sortTimeAscending": false,
    "sortScoreMethod": "string"
}

string

cursor

Optional

The id (exclusive) from which search results resume returning. Users should supply an entity 'id' to this property. Its main purpose is to resume where a previous search left off because of the 'limit' parameter. If a user supplies the last id in a set of results to cursor, while keeping the query the same, the system will return the next page of results

integer As int32 As int32

limit

Optional

The number of results to return. Default: 100

array of SearchQuery

query

Optional

A list of queries by which to limit the search results

EventTimeRange

timeRange

Optional

Refinement of time range over which to search (for events). Operates on the start time of the event.

RelatedEventTimeRange

relatedEventTimeRange

Optional

Refinement of time range over which to search over a firing event with no default value. Operates on the start time of the event.

boolean

sortTimeAscending

Optional

Whether to sort event results ascending in start time. Default: false

string

sortScoreMethod

Optional

Whether to sort events on similarity score : {NONE, SCORE_ASC, SCORE_DES}. Default: NONE. If sortScoreMethod is set to SCORE_ASC or SCORE_DES, it will override time sort