Get parameters by thing-definition

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

Returns the list of configuration-parameters 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 configuration-parameter object identifier.

name
string

The configuration-parameter name.

label
string

The configuration-parameter label.

type
string

The configuration-parameter type.

Valid values[ "BOOLEAN", "DOUBLE", "FLOAT", "INTEGER", "LONG", "STRING", "BASE64", "DATE" ]
stepValue
number

The increment step value for numeric parameters.

minValue
number

The minimum valid value for numeric parameters.

maxValue
number

The maximum valid value for numeric parameters.

selectionMode
string

The selection mode for multi value field.

Valid values[ "SELECTION", "RADIO_BUTTON" ]
mandatory
boolean

The flag indicating whether the parameter field cannot be left empty.

values
Array of object

The allowed values in case of multiple selection.

object
name
string

The selection item name.

Examplec1
label
string

The selection item label.

ExampleValue 1
mapping
object

The parameter mapping used to send values to the thing.

path
string

The parameter mapping path.

Exampleconfig
name
string

The parameter mapping name.

Examplepar1
enabledCondition
object

The condition that enables or disables the parameter input field 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.

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