Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Report event

Prev Next
Post
/inventory/historicalEvents

Reports a new event that is registered into the historical events, without being evaluated by an alert-definition.
This is typically used to trace what happened outside of the DPS, such as an on-site inspection, a failure reported by a technician or an anomaly detected by an external system.
The payload must identify the thing involved, the severity and the time interval of the event.

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

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

Body parameters

The details of the event being created.

object
alertDefinitionId
string

The identifier of the event-definition associated with the event.

Example1234abcd
startTimestamp
integer (int64)

The event start timestamp.

Example1578438000000
endTimestamp
integer (int64)

The event end timestamp.

Example1578438000000
locationId
string

The location identifier associated with the event.

thingId
string

The thing identifier associated with the event.

activateUserEmail
string

The email of the user who has reported the event.

Examplemark.hamill@abon-metal.com
notes
string

The text notes in case of User Reported event.

ExampleThe machine was....
Responses
201

Successfully created.

object
id
string

The event object identifier.

Example1234abcd
alertDefinitionId
string

The identifier of the event-definition associated with the event.

Example1234abcd
name
string

The event name.

ExampleE450
title
string

The event title.

ExampleOverheating
description
string

The event description.

ExampleHigh temperature detected
technicalDescription
string

The event technical description.

startTimestamp
integer (int64)

The event start timestamp.

Example1578438000000
endTimestamp
integer (int64)

The event end timestamp.

Example1578438000000
eventSeverity
integer

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

Valid values[ 1, 2, 3, 4, 5 ]
customerId
string

The customer identifier associated with the event.

locationId
string

The location identifier associated with the event.

thingId
string

The thing identifier associated with the event.

activateUserEmail
string

The email of the user who has reported the event.

Examplemark.hamill@abon-metal.com
notes
string

The text notes in case of User Reported event.

ExampleThe machine was....
400

Request data not valid.

object
message
string

The error response.

ExampleBad request
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
429

API call rate limit exceeded.

object
message
string

The error response.

ExampleAPI call rate limit exceeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error