Get thing-definitions

Prev Next
Get
/inventory/thingDefinitions

Returns the list of thing-definitions.

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

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

Responses
200

Successful operation.

Array of object
object
id
string

The thing definition object identifier.

name
string

The thing definition name.

description
string

The thing definition description.

defaultThingName
string

The placeholder based value to use in thing naming.

nameMetricId
string

The identifier of the metric providing the Thing name.

serialNumberMetricId
string

The identifier of the metric providing the Thing serial number.

gpsPositionMetricId
string

The identifier of the metric providing the Thing GPS position in the form "latitude,longitude".

thingDefinitionMetricId
string

The identifier of the metric providing the name of the thing-definition used to dynamically change the thing-definition associated with a thing.

superThingDefinitionId
string

The identifier of the super thing-definition from where this thing-definition is inheriting elements (can be set only during creation).

parentThingDefinitionId
string

The identifier of the parent thing-definition this thing-definition is part of.

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