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.

Update an event

Prev Next
Put
/inventory/historicalEvents/{eventId}

Update a historical event, for instance to correct its severity, to complete its description and notes, or to set the endTimestamp that closes it.
Being a full update, the payload should provide the complete event object.

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

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

Path parameters
eventId
stringRequired

The event identifier.

Minimum1.0
Exampleabcd1234
Body parameters

The details of the event to update.

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
200

Successfully updated.

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