Device
| parameter | description |
|---|---|
| id | the device id can be retrieved by accessing the web platform and going to the device detail page (eg.: https://app.things5.digital/machines/4efe48f3-7619-4e27-826b-d710654adbc1 the 4efe48f3-7619-4e27-826b-d710654adbc1 is actually the device id) |
Model
| parameter | description |
|---|---|
| id | the model id can be retrieved by accessing the web platform and going to the model detail page (eg.: https://staging.things5.digital/machines/models/234abc5d-a9c6-4ebc-aa11-883f2e103a33 the 234abc5d-a9c6-4ebc-aa11-883f2e103a33 is actually the model id) |
Metrics, events, states
| parameter | description |
|---|---|
| name | the name of the variable, it can be retrieved by reading the device-specific configuration file, provided by the hardware manufacturer |
| from | define the start time boundary of your request |
| to | define the final boundary of your request |
| metric_names | see "name" |
| event_names | see "name" |
| states_names | see "name" |
User
| parameter | description |
|---|---|
| username | the email with which the user has been registered to the platform |
| password | the password that the user has set to access the platform |
Realm and organisation
| parameter | description |
|---|---|
| realm-id | the realm-id can be retrieved by going to the login page (es.: https://app.things5.digital) and reading the path between /realms/ and /protocol/ (es.: in https://auth.things5.digital/auth/realms/things5-production/protocol/openid-connect the realm-id is things5-production) |