GET api/Events/GetEvents?pageIndex={pageIndex}&pageSize={pageSize}

Gets a list of all Events. Pagination is supported.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageIndex

Optional page index (default is 0).

integer

None.

pageSize

Optional page size (default is 200).

integer

None.

Body Parameters

None.

Response Information

Resource Description

GetEventsResult
NameDescriptionTypeAdditional information
PagedEvents

A page with Event rows.

EventRow

None.

Response Formats

application/json, text/json

Sample:
{
  "PagedEvents": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 1,
    "TotalPages": 1,
    "Items": [
      {
        "Id": 1,
        "UserProviderKey": "64e829da-3ba8-44af-94ce-97f5fd3fd1d9",
        "FullName": "John Doe",
        "DateAddUtc": "2024-04-27T02:02:18.0638409Z",
        "Type": 12,
        "Ip": null,
        "Os": null,
        "Browser": null,
        "TicketId": null,
        "TicketSubject": null,
        "TicketREF": null,
        "CustomerName": null,
        "CustomerId": null,
        "PriorityName": null,
        "PropertyName": null,
        "OldValue": null,
        "NewValue": null,
        "IsAvailable": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<GetEventsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedEvents>
    <Items>
      <GetEventsResult.EventRow>
        <Browser i:nil="true" />
        <CustomerId i:nil="true" />
        <CustomerName i:nil="true" />
        <DateAddUtc>2024-04-27T02:02:18.0638409Z</DateAddUtc>
        <FullName>John Doe</FullName>
        <Id>1</Id>
        <Ip i:nil="true" />
        <IsAvailable>true</IsAvailable>
        <NewValue i:nil="true" />
        <OldValue i:nil="true" />
        <Os i:nil="true" />
        <PriorityName i:nil="true" />
        <PropertyName i:nil="true" />
        <TicketId i:nil="true" />
        <TicketREF i:nil="true" />
        <TicketSubject i:nil="true" />
        <Type>ChangeAvailabilityInAutomaticTicketAssignment</Type>
        <UserProviderKey>64e829da-3ba8-44af-94ce-97f5fd3fd1d9</UserProviderKey>
      </GetEventsResult.EventRow>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalItems>1</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedEvents>
</GetEventsResult>