Get me historical events

  • 1 minute(s) read
Prev Next
Get
/v2/identity/users/me/historicalEvents

Returns the list of historical events.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
customerId
string

Condition on customer id.

Exampleabcd1234
locationId
string

Condition on location id.

Exampleabcd1234
thingId
string

Condition on thing id.

Exampleabcd1234
eventSeverity
string

Condition on event severity (1:FAILURE, 2:MAJOR ANOMALY, 3:MINOR ANOMALY, 4:OPERATION, 5:MAINTENANCE).

Example1
topics
string

Condition to get events by topics (CONNECTION, CONSUMPTION, DOWNTIME, HEALTH, MAINTENANCE, PRODUCTIVITY, QUALITY, UPTIME).

Examplein;HEALTH,MAINTENANCE
minStartTimestamp
integer (int64)

Condition to get events started after a specific timestamp.

Example1578438000000
maxStartTimestamp
integer (int64)

Condition to get events started before a specific timestamp.

Example1578438000000
size
integer

The number of elements to retrieve for the current page.

Minimum1.0
Example200
page
integer

The page number to retrieve (zero-based).

Minimum0.0
Example0
sort
string

The sorting criteria based on object properties.

Minimum0.0
Examplename,ASC
Responses
200

Successful operation.

Expand All
object
content
Array of object (Event)
object
id
string
Example1234abcd
alertDefinitionId
string
Example1234abcd
name
string
ExampleE450
title
string
ExampleOverheating
description
string
ExampleHigh temperature detected
technicalDescription
string
startTimestamp
integer (int64)
Example1578438000000
endTimestamp
integer (int64)
Example1578438000000
eventSeverity
integer
Valid values[ 1, 2, 3, 4, 5 ]
customerId
string
locationId
string
thingId
string
notes
string
ExampleMaintenance notes
first
boolean
last
boolean
totalPages
integer
totalElements
integer
sort
string
numberOfElements
integer
size
integer
number
integer
Minimum0.0
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error