Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventsGetByTypeOptionalParams

Package version

interface

An interface representing EventsGetByTypeOptionalParams. Optional Parameters.

extends

RequestOptionsBase

Hierarchy

  • any
    • EventsGetByTypeOptionalParams

Index

Properties

Optional apply

apply: undefined | string
member

{string} [apply] An expression used for aggregation over returned events

Optional count

count: undefined | false | true
member

{boolean} [count] Request a count of matching items included with the returned events

Optional filter

filter: undefined | string
member

{string} [filter] An expression used to filter the returned events

Optional format

format: undefined | string
member

{string} [format] Format for the returned events

Optional orderby

orderby: undefined | string
member

{string} [orderby] A comma-separated list of properties with "asc" (the default) or "desc" to control the order of returned events

Optional search

search: undefined | string
member

{string} [search] A free-text search expression to match for whether a particular event should be returned

Optional select

select: undefined | string
member

{string} [select] Limits the properties to just those requested on each returned event

Optional skip

skip: undefined | number
member

{number} [skip] The number of items to skip over before returning events

Optional timespan

timespan: undefined | string
member

{string} [timespan] Optional. The timespan over which to retrieve events. This is an ISO8601 time period value. This timespan is applied in addition to any that are specified in the Odata expression.

Optional top

top: undefined | number
member

{number} [top] The number of events to return

Generated using TypeDoc