Get commands by thing-definition

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

Returns the list of commands of a specific thing-definition.

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

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

Path parameters
thingDefinitionId
stringRequired

The thing-definition identifier.

Minimum1.0
Exampleabcd1234
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 define the toggle command status.

predicate
string

The condition predicate.

Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string

The condition value to check.

runningCondition
object

The condition that define whether the command is running.

predicate
string

The condition predicate.

Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string

The condition value to check.

enabledCondition
object

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

predicate
string

The condition predicate.

Valid values[ "EQUAL", "NOT_EQUAL", "LESS", "GREATER", "LESS_EQUAL", "GREATER_EQUAL" ]
value
string

The condition value to check.

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