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.

Get commands by thing-definition

Prev Next
Get
/inventory/thingDefinitions/{thingDefinitionId}/commands

Returns the list of commands of a specific thing-definition.
A command is a remote operation that can be executed on a thing (for instance start, stop or reset), described by its parameters, by the mapping used to deliver them to the product and by the conditions that define when it is enabled and when it is running.
Set includeInherited to true to obtain also the commands inherited from the parent thing-definitions.

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

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

Path parameters
thingDefinitionId
stringRequired

The thing-definition identifier.

Minimum1.0
Exampleabcd1234
Query parameters
includeInherited
boolean

If true, the response includes the elements inherited from parent thing definitions.

Responses
200

Successful operation.

Array of object
object
id
string

The command object identifier.

name
string

The command name.

secure
boolean

The flag indicating whether the command is secured.

onCondition
object

The condition that defines the toggle command status.

metric
object
id
string
Example1234abcd
predicate
string
Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string
runningCondition
object

The condition that defines whether the command is running.

metric
object
id
string
Example1234abcd
predicate
string
Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string
enabledCondition
object

The condition that enables or disables the command button within the page.

metric
object
id
string
Example1234abcd
predicate
string
Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string
mapping
object

The command mapping used to send parameters to the thing.

path
string

The command mapping path.

Exampleexecute
parameters
Array of object

The parameters sent by the command.

object
name
string

The selection item name.

Examplepar1
type
string

The parameter type.

Valid values[ "BOOLEAN", "DOUBLE", "FLOAT", "INTEGER", "LONG", "ARRAY", "STRING" ]
value

The parameter value.

onCondition
boolean

The flag indicating whether the parameter must be sent according to the on-condition status; if omitted, it is always sent.

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 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