Get maintenance works

Prev Next
Get
Deprecated
/inventory/maintenanceWorks

Returns the list of maintenance works performed on a thing or location.
At least one of thingId or locationId parameters is required.

Required permissions: READ_MAINTENANCE_REGISTRY.

Use the EVENTS endboints instead.

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

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

Query parameters
thingId
string

Condition on thing id.

Exampleabcd1234
locationId
string

Condition on location id.

Exampleabcd1234
Responses
200

Successful operation.

Array of object
object

The object provisding information of a maintenance activity performed on a thing or location.

id
string

The maintenance work object identifier.

startTimestamp
integer (int64)

The timestamp when the maintenance work started.

Example1578438000000
endTimestamp
integer (int64)

The timestamp when the maintenance work completed.

Example1578438000000
type
string

The maintenance event type.

ExampleREPAIR
description
string

The description of the performed activities.

ExampleMain unit repair...
outcome
string

The ourcome of the performed activities.

ExampleImpossible to reset error...
userEmail
string

The email address of the user that has performed the maintenance.

thingId
string

The thing identifier in case of thing maintenance.

locationId
string

The location identifier in case of location maintenance.

properties
object (Properties)

The set of properties providing additional details to the parent object.

Example{ "foo": "abc", "bar": "123" }
property*
string additionalProperties
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