# BasePath: /v3 Api Version: v3 ## APIs ### /environments #### **POST** `/environments/{id}/rooms/{id}/things/{id}/move/{x}/{y}` ##### move Move a thing to another position ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/move/{x}/{y} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to move string
x true Left offset int
y true Top offset int
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms/{id}/things/{id}/click` ##### click Send a ObjectClickEvent for related thing ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/click ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to click string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms/{id}/things/templates/{name}/instantiate` ##### instantiateTemplate Add a new thing, based on selected template ###### URL /v3/environments/{id}/rooms/{id}/things/templates/{name}/instantiate ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
name true Name of thing template (e.g. Light, Thermostat) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Template not found | - | | 201 | Thing added | - | - - - #### **GET** `/environments/{id}/rooms/{id}/things/templates` ##### listTemplates List all thing templates ###### URL /v3/environments/{id}/rooms/{id}/things/templates ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms/{id}/things/{id}/behaviorchange/{bid}/{value}` ##### behaviorChange Fire a behavior change request, using provided data ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviorchange/{bid}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to click string
bid true name of behavior string
value true desired value of behavior string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things/{id}/move/{x}/{y}` ##### move Move a thing to another position ###### URL /v3/environments/{id}/things/{id}/move/{x}/{y} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to move string
x true Left offset int
y true Top offset int
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things/{id}/click` ##### click Send a ObjectClickEvent for related thing ###### URL /v3/environments/{id}/things/{id}/click ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to click string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things/templates/{name}/instantiate` ##### instantiateTemplate Add a new thing, based on selected template ###### URL /v3/environments/{id}/things/templates/{name}/instantiate ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
name true Name of thing template (e.g. Light, Thermostat) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Template not found | - | | 201 | Thing added | - | - - - #### **GET** `/environments/{id}/things/templates` ##### listTemplates List all thing templates ###### URL /v3/environments/{id}/things/templates ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things/{id}/behaviorchange/{bid}/{value}` ##### behaviorChange Fire a behavior change request, using provided data ###### URL /v3/environments/{id}/things/{id}/behaviorchange/{bid}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to click string
bid true name of behavior string
value true desired value of behavior string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/environments` ##### list List all environments ###### URL /v3/environments ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments` ##### create Add a new environment ###### URL /v3/environments ###### Parameters - body
Parameter Required Description Data Type
body false Environment
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New environment added | - | - - - #### **POST** `/environments` ##### create Add a new environment ###### URL /v3/environments ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New environment added | - | - - - #### **GET** `/environments/{id}/rooms` ##### list List all rooms ###### URL /v3/environments/{id}/rooms ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms` ##### create Add a new room ###### URL /v3/environments/{id}/rooms ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New room added | - | - - - #### **POST** `/environments/{id}/rooms` ##### create Add a new room ###### URL /v3/environments/{id}/rooms ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Zone
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New room added | - | - - - #### **GET** `/environments/{id}/rooms/{id}/things/` ##### list List all things ###### URL /v3/environments/{id}/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms/{id}/things/` ##### create Add a new thing ###### URL /v3/environments/{id}/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **POST** `/environments/{id}/rooms/{id}/things/` ##### create Add a new thing ###### URL /v3/environments/{id}/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **GET** `/environments/{id}/rooms/{id}/things/{id}/behaviors` ##### list Get a list of items ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/rooms/{id}/things/{id}/behaviors` ##### create Create a new item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/environments/{id}/things` ##### list List all things ###### URL /v3/environments/{id}/things ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things` ##### create Add a new thing ###### URL /v3/environments/{id}/things ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **POST** `/environments/{id}/things` ##### create Add a new thing ###### URL /v3/environments/{id}/things ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **GET** `/environments/{id}/things/{id}/behaviors` ##### list Get a list of items ###### URL /v3/environments/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/environments/{id}/things/{id}/behaviors` ##### create Create a new item ###### URL /v3/environments/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/environments/{id}` ##### get Get an environment ###### URL /v3/environments/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Environment not found | - | - - - #### **PUT** `/environments/{id}` ##### update Update an environment ###### URL /v3/environments/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Environment not modified | - | - - - #### **PUT** `/environments/{id}` ##### update Update an environment ###### URL /v3/environments/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Environment
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Environment not modified | - | - - - #### **DELETE** `/environments/{id}` ##### delete Delete an environment ###### URL /v3/environments/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Environment not found | - | - - - #### **GET** `/environments/{id}/rooms/{id}` ##### get Get a room ###### URL /v3/environments/{id}/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Room not found | - | - - - #### **PUT** `/environments/{id}/rooms/{id}` ##### update Update a room ###### URL /v3/environments/{id}/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Zone
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Room not modified | - | - - - #### **PUT** `/environments/{id}/rooms/{id}` ##### update Update a room ###### URL /v3/environments/{id}/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Room not modified | - | - - - #### **DELETE** `/environments/{id}/rooms/{id}` ##### delete Delete a room ###### URL /v3/environments/{id}/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Room not found | - | - - - #### **GET** `/environments/{id}/rooms/{id}/things/{id}` ##### get Get a thing ###### URL /v3/environments/{id}/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **PUT** `/environments/{id}/rooms/{id}/things/{id}` ##### update Update a thing ###### URL /v3/environments/{id}/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **PUT** `/environments/{id}/rooms/{id}/things/{id}` ##### update Update a thing ###### URL /v3/environments/{id}/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **DELETE** `/environments/{id}/rooms/{id}/things/{id}` ##### delete Delete a thing ###### URL /v3/environments/{id}/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **GET** `/environments/{id}/rooms/{id}/things/{id}/behaviors/{id}` ##### get Get a single item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/environments/{id}/rooms/{id}/things/{id}/behaviors/{id}` ##### update Update an item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/environments/{id}/rooms/{id}/things/{id}/behaviors/{id}` ##### delete Delete an item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **GET** `/environments/{id}/things/{id}` ##### get Get a thing ###### URL /v3/environments/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **PUT** `/environments/{id}/things/{id}` ##### update Update a thing ###### URL /v3/environments/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **PUT** `/environments/{id}/things/{id}` ##### update Update a thing ###### URL /v3/environments/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **DELETE** `/environments/{id}/things/{id}` ##### delete Delete a thing ###### URL /v3/environments/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **GET** `/environments/{id}/things/{id}/behaviors/{id}` ##### get Get a single item ###### URL /v3/environments/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/environments/{id}/things/{id}/behaviors/{id}` ##### update Update an item ###### URL /v3/environments/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/environments/{id}/things/{id}/behaviors/{id}` ##### delete Delete an item ###### URL /v3/environments/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/environments/{id}/rooms/{id}/things/{id}/behaviors/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/behaviors/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/environments/{id}/rooms/{id}/things/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/rooms/{id}/things/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of room to fetch things from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/environments/{id}/rooms/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/rooms/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch rooms from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/environments/{id}/things/{id}/behaviors/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/things/{id}/behaviors/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true UUID of thing to fetch behaviors from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/environments/{id}/things/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/things/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of environment to fetch things from (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/environments/{id}/copy` ##### copy Copy an item ###### URL /v3/environments/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /behaviors #### **GET** `/` ##### list Get a list of items ###### URL /v3/ ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/` ##### create Create a new item ###### URL /v3/ ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/{id}` ##### get Get a single item ###### URL /v3/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/{id}` ##### update Update an item ###### URL /v3/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/{id}` ##### delete Delete an item ###### URL /v3/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/{id}/copy` ##### copy Copy an item ###### URL /v3/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /roles #### **GET** `/system/roles` ##### list Get a list of items ###### URL /v3/system/roles ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/system/roles` ##### create Create a new item ###### URL /v3/system/roles ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/system/roles/{id}` ##### get Get a single item ###### URL /v3/system/roles/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/system/roles/{id}` ##### update Update an item ###### URL /v3/system/roles/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/system/roles/{id}` ##### delete Delete an item ###### URL /v3/system/roles/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/system/roles/{id}/copy` ##### copy Copy an item ###### URL /v3/system/roles/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /rooms #### **POST** `/rooms/{id}/things/{id}/move/{x}/{y}` ##### move Move a thing to another position ###### URL /v3/rooms/{id}/things/{id}/move/{x}/{y} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to move string
x true Left offset int
y true Top offset int
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms/{id}/things/{id}/click` ##### click Send a ObjectClickEvent for related thing ###### URL /v3/rooms/{id}/things/{id}/click ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to click string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms/{id}/things/templates/{name}/instantiate` ##### instantiateTemplate Add a new thing, based on selected template ###### URL /v3/rooms/{id}/things/templates/{name}/instantiate ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
name true Name of thing template (e.g. Light, Thermostat) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Template not found | - | | 201 | Thing added | - | - - - #### **GET** `/rooms/{id}/things/templates` ##### listTemplates List all thing templates ###### URL /v3/rooms/{id}/things/templates ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms/{id}/things/{id}/behaviorchange/{bid}/{value}` ##### behaviorChange Fire a behavior change request, using provided data ###### URL /v3/rooms/{id}/things/{id}/behaviorchange/{bid}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to click string
bid true name of behavior string
value true desired value of behavior string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/rooms` ##### list List all rooms ###### URL /v3/rooms ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms` ##### create Add a new room ###### URL /v3/rooms ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New room added | - | - - - #### **POST** `/rooms` ##### create Add a new room ###### URL /v3/rooms ###### Parameters - body
Parameter Required Description Data Type
body false Zone
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New room added | - | - - - #### **GET** `/rooms/{id}/things/` ##### list List all things ###### URL /v3/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms/{id}/things/` ##### create Add a new thing ###### URL /v3/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **POST** `/rooms/{id}/things/` ##### create Add a new thing ###### URL /v3/rooms/{id}/things/ ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **GET** `/rooms/{id}/things/{id}/behaviors` ##### list Get a list of items ###### URL /v3/rooms/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/rooms/{id}/things/{id}/behaviors` ##### create Create a new item ###### URL /v3/rooms/{id}/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/rooms/{id}` ##### get Get a room ###### URL /v3/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Room not found | - | - - - #### **PUT** `/rooms/{id}` ##### update Update a room ###### URL /v3/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Zone
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Room not modified | - | - - - #### **PUT** `/rooms/{id}` ##### update Update a room ###### URL /v3/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Room not modified | - | - - - #### **DELETE** `/rooms/{id}` ##### delete Delete a room ###### URL /v3/rooms/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Room not found | - | - - - #### **GET** `/rooms/{id}/things/{id}` ##### get Get a thing ###### URL /v3/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **PUT** `/rooms/{id}/things/{id}` ##### update Update a thing ###### URL /v3/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **PUT** `/rooms/{id}/things/{id}` ##### update Update a thing ###### URL /v3/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **DELETE** `/rooms/{id}/things/{id}` ##### delete Delete a thing ###### URL /v3/rooms/{id}/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **GET** `/rooms/{id}/things/{id}/behaviors/{id}` ##### get Get a single item ###### URL /v3/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/rooms/{id}/things/{id}/behaviors/{id}` ##### update Update an item ###### URL /v3/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/rooms/{id}/things/{id}/behaviors/{id}` ##### delete Delete an item ###### URL /v3/rooms/{id}/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/rooms/{id}/things/{id}/behaviors/{id}/copy` ##### copy Copy an item ###### URL /v3/rooms/{id}/things/{id}/behaviors/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true UUID of thing to fetch behaviors from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/rooms/{id}/things/{id}/copy` ##### copy Copy an item ###### URL /v3/rooms/{id}/things/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of room to fetch things from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/rooms/{id}/copy` ##### copy Copy an item ###### URL /v3/rooms/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /things #### **POST** `/things/{id}/move/{x}/{y}` ##### move Move a thing to another position ###### URL /v3/things/{id}/move/{x}/{y} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to move string
x true Left offset int
y true Top offset int
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/things/{id}/click` ##### click Send a ObjectClickEvent for related thing ###### URL /v3/things/{id}/click ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to click string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/things/templates/{name}/instantiate` ##### instantiateTemplate Add a new thing, based on selected template ###### URL /v3/things/templates/{name}/instantiate ###### Parameters - path
Parameter Required Description Data Type
name true Name of thing template (e.g. Light, Thermostat) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Template not found | - | | 201 | Thing added | - | - - - #### **GET** `/things/templates` ##### listTemplates List all thing templates ###### URL /v3/things/templates ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/things/{id}/behaviorchange/{bid}/{value}` ##### behaviorChange Fire a behavior change request, using provided data ###### URL /v3/things/{id}/behaviorchange/{bid}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to click string
bid true name of behavior string
value true desired value of behavior string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/things` ##### list List all things ###### URL /v3/things ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/things` ##### create Add a new thing ###### URL /v3/things ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **POST** `/things` ##### create Add a new thing ###### URL /v3/things ###### Parameters - body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New thing created | - | - - - #### **GET** `/things/{id}/behaviors` ##### list Get a list of items ###### URL /v3/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/things/{id}/behaviors` ##### create Create a new item ###### URL /v3/things/{id}/behaviors ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/things/{id}` ##### get Get a thing ###### URL /v3/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **PUT** `/things/{id}` ##### update Update a thing ###### URL /v3/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **PUT** `/things/{id}` ##### update Update a thing ###### URL /v3/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false EnvObject
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Thing not modified | - | - - - #### **DELETE** `/things/{id}` ##### delete Delete a thing ###### URL /v3/things/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Thing not found | - | - - - #### **GET** `/things/{id}/behaviors/{id}` ##### get Get a single item ###### URL /v3/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
id true ID of item to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **PUT** `/things/{id}/behaviors/{id}` ##### update Update an item ###### URL /v3/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/things/{id}/behaviors/{id}` ##### delete Delete an item ###### URL /v3/things/{id}/behaviors/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/things/{id}/behaviors/{id}/copy` ##### copy Copy an item ###### URL /v3/things/{id}/behaviors/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true UUID of thing to fetch behaviors from string
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **POST** `/things/{id}/copy` ##### copy Copy an item ###### URL /v3/things/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /reactions #### **GET** `/reactions` ##### list List all reactions ###### URL /v3/reactions ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/reactions` ##### create Add a new reaction ###### URL /v3/reactions ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New reaction added | - | - - - #### **POST** `/reactions` ##### create Add a new reaction ###### URL /v3/reactions ###### Parameters - body
Parameter Required Description Data Type
body false ReactionRepresentation
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New reaction added | - | - - - #### **GET** `/reactions/{id}` ##### get Get a reaction ###### URL /v3/reactions/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of reaction to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Reaction not found | - | - - - #### **PUT** `/reactions/{id}` ##### update Update a reaction ###### URL /v3/reactions/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of reaction to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false ReactionRepresentation
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Reaction not modified | - | - - - #### **PUT** `/reactions/{id}` ##### update Update a reaction ###### URL /v3/reactions/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of reaction to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Reaction not modified | - | - - - #### **DELETE** `/reactions/{id}` ##### delete Delete a reaction ###### URL /v3/reactions/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of reaction to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Reaction not found | - | - - - #### **POST** `/reactions/{id}/copy` ##### copy Copy an item ###### URL /v3/reactions/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /triggers #### **GET** `/triggers` ##### list List all triggers ###### URL /v3/triggers ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/triggers` ##### create Add a new trigger ###### URL /v3/triggers ###### Parameters - body
Parameter Required Description Data Type
body false Trigger
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New trigger added | - | - - - #### **POST** `/triggers` ##### create Add a new trigger ###### URL /v3/triggers ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New trigger added | - | - - - #### **GET** `/triggers/{id}` ##### get Get a trigger ###### URL /v3/triggers/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of trigger to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Trigger not found | - | - - - #### **PUT** `/triggers/{id}` ##### update Update a trigger ###### URL /v3/triggers/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of trigger to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Trigger not modified | - | - - - #### **PUT** `/triggers/{id}` ##### update Update a trigger ###### URL /v3/triggers/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of trigger to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Trigger
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Trigger not modified | - | - - - #### **DELETE** `/triggers/{id}` ##### delete Delete a trigger ###### URL /v3/triggers/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of trigger to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Trigger not found | - | - - - #### **POST** `/triggers/{id}/copy` ##### copy Copy an item ###### URL /v3/triggers/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /userCommands #### **POST** `/commands/user/{id}/run` ##### fire Fire a user's command ###### URL /v3/commands/user/{id}/run ###### Parameters - path
Parameter Required Description Data Type
id true UUID of user's command to execute string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/commands/user/runonce` ##### fire Fire a custom command ###### URL /v3/commands/user/runonce ###### Parameters - body
Parameter Required Description Data Type
body false Command
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/commands/user/nlp/{id}/run` ##### NlpFire Fire a command recognized by NLP ###### URL /v3/commands/user/nlp/{id}/run ###### Parameters - path
Parameter Required Description Data Type
id true Command name to execute string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | No similar command found and executed | - | - - - #### **GET** `/commands/user` ##### list List all user's commands ###### URL /v3/commands/user ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/commands/user` ##### create Add a new user's command ###### URL /v3/commands/user ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New user's command added | - | - - - #### **POST** `/commands/user` ##### create Add a new user's command ###### URL /v3/commands/user ###### Parameters - body
Parameter Required Description Data Type
body false Command
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New user's command added | - | - - - #### **GET** `/commands/user/{id}` ##### get Get a user's command ###### URL /v3/commands/user/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of user's command to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | User's command not found | - | - - - #### **PUT** `/commands/user/{id}` ##### update Update a user's command ###### URL /v3/commands/user/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of user's command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Command
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | User's command not modified | - | - - - #### **PUT** `/commands/user/{id}` ##### update Update a user's command ###### URL /v3/commands/user/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of user's command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | User's command not modified | - | - - - #### **DELETE** `/commands/user/{id}` ##### delete Delete a user's command ###### URL /v3/commands/user/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of user's command to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | User's command not found | - | - - - #### **POST** `/commands/user/{id}/copy` ##### copy Copy an item ###### URL /v3/commands/user/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /hardwareCommands #### **GET** `/commands/hardware` ##### list List all hardware commands ###### URL /v3/commands/hardware ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/commands/hardware` ##### create Add a new hardware command ###### URL /v3/commands/hardware ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New hardware command added | - | - - - #### **POST** `/commands/hardware` ##### create Add a new hardware command ###### URL /v3/commands/hardware ###### Parameters - body
Parameter Required Description Data Type
body false Command
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New hardware command added | - | - - - #### **GET** `/commands/hardware/{id}` ##### get Get a hardware command ###### URL /v3/commands/hardware/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of hardware command to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Hardware command not found | - | - - - #### **PUT** `/commands/hardware/{id}` ##### update Update a hardware command ###### URL /v3/commands/hardware/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of hardware command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Hardware command not modified | - | - - - #### **PUT** `/commands/hardware/{id}` ##### update Update a hardware command ###### URL /v3/commands/hardware/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of hardware command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66) string
- body
Parameter Required Description Data Type
body false Command
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Hardware command not modified | - | - - - #### **DELETE** `/commands/hardware/{id}` ##### delete Delete a hardware command ###### URL /v3/commands/hardware/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of hardware command to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66 string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Hardware command not found | - | - - - #### **POST** `/commands/hardware/{id}/copy` ##### copy Copy an item ###### URL /v3/commands/hardware/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /plugins #### **POST** `/plugins/{id}/start` ##### start Start a plugin ###### URL /v3/plugins/{id}/start ###### Parameters - path
Parameter Required Description Data Type
id true Classname of plugin string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Plugin not found | - | | 202 | Plugin started | - | | 304 | Plugin not started | - | - - - #### **POST** `/plugins/{id}/stop` ##### stop Stop a plugin ###### URL /v3/plugins/{id}/stop ###### Parameters - path
Parameter Required Description Data Type
id true Classname of plugin string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Plugin not found | - | | 202 | Plugin stopped | - | | 304 | Plugin not stopped | - | - - - #### **GET** `/plugins` ##### list List all installed plugins ###### URL /v3/plugins ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/plugins` ##### create Create a new item ###### URL /v3/plugins ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New item created | - | - - - #### **GET** `/plugins/{id}` ##### get Get a plugin ###### URL /v3/plugins/{id} ###### Parameters - path
Parameter Required Description Data Type
id true UUID of plugin to fetch (e.g. logviewer, automationseditor) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Plugin not found | - | - - - #### **PUT** `/plugins/{id}` ##### update Update an item ###### URL /v3/plugins/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to update string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | Item not modified | - | - - - #### **DELETE** `/plugins/{id}` ##### delete Delete an item ###### URL /v3/plugins/{id} ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Item not found | - | - - - #### **POST** `/plugins/{id}/copy` ##### copy Copy an item ###### URL /v3/plugins/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - ### /resources #### **GET** `/resources/{id}` ##### getWithFallback Get an image or a redirect to it ###### URL /v3/resources/{id} ###### Parameters - path
Parameter Required Description Data Type
id true Name of image file to fetch string
- query
Parameter Required Description Data Type
fbId false Name of alternate image file to fetch string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Image not found | - | - - - ### /system #### **POST** `/system/exit` ##### exit Initiate shutdown procedure ###### URL /v3/system/exit ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/system/info/messaging` ##### listMessaginsSettings Show information about the messaging system ###### URL /v3/system/info/messaging ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/system/info/framework` ##### listFrameworkSettings Show information about Freedomotic framework ###### URL /v3/system/info/framework ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/system/info/paths` ##### listPathSettings Show information about configured paths ###### URL /v3/system/info/paths ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/system/info/languages` ##### listLanguages Show supported languages ###### URL /v3/system/info/languages ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - ### /users #### **POST** `/users/_/logout` ##### logout Get current user ###### URL /v3/users/_/logout ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/users/_/login` ##### login Login a user ###### URL /v3/users/_/login ###### Parameters - form
Parameter Required Description Data Type
name false string
password false string
rememberMe false boolean
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/users/{id}/ispermitted/{action}` ##### isPermitted Check user's permissions ###### URL /v3/users/{id}/ispermitted/{action} ###### Parameters - path
Parameter Required Description Data Type
id true User to check permission from string
action true Action to check user's permission against string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/users/_` ##### getCurrentUser Get current user ###### URL /v3/users/_ ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/users/{id}/roles` ##### list List roles ###### URL /v3/users/{id}/roles ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/users/{id}/roles` ##### add Add a role ###### URL /v3/users/{id}/roles ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
name true Role to add string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/users/{id}/properties` ##### list Get every property ###### URL /v3/users/{id}/properties ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **PUT** `/users/{id}/properties` ##### updateAll Modify the whole properties with a new set ###### URL /v3/users/{id}/properties ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
- body
Parameter Required Description Data Type
body false Properties
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/users` ##### list List all users ###### URL /v3/users ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/users` ##### create Add a new user ###### URL /v3/users ###### Parameters - body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New user added | - | - - - #### **POST** `/users` ##### create Add a new user ###### URL /v3/users ###### Parameters - body
Parameter Required Description Data Type
body false UserRepresentation
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 201 | New user added | - | - - - #### **GET** `/users/{id}` ##### get Get an user ###### URL /v3/users/{id} ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch (e.g. admin, guest) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | User not found | - | - - - #### **PUT** `/users/{id}` ##### update Update an user ###### URL /v3/users/{id} ###### Parameters - path
Parameter Required Description Data Type
id true User to update (e.g. admin, guest) string
- body
Parameter Required Description Data Type
body false UserRepresentation
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | User not modified | - | - - - #### **PUT** `/users/{id}` ##### update Update an user ###### URL /v3/users/{id} ###### Parameters - path
Parameter Required Description Data Type
id true User to update (e.g. admin, guest) string
- body
Parameter Required Description Data Type
body false Object
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 304 | User not modified | - | - - - #### **DELETE** `/users/{id}` ##### delete Delete an user ###### URL /v3/users/{id} ###### Parameters - path
Parameter Required Description Data Type
id true User to delete (e.g. admin, guest) string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | User not found | - | - - - #### **GET** `/users/{id}/properties/{key}` ##### get Get a single property ###### URL /v3/users/{id}/properties/{key} ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
key true Key to retrieve string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **DELETE** `/users/{id}/roles/{name}` ##### delete Delete a role ###### URL /v3/users/{id}/roles/{name} ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
name true Role to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Role not found | - | - - - #### **POST** `/users/{id}/copy` ##### copy Copy an item ###### URL /v3/users/{id}/copy ###### Parameters - path
Parameter Required Description Data Type
id true ID of item to copy string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Source item not found | - | - - - #### **PUT** `/users/{id}/properties/{key}/{value}` ##### updateSingle Modify a single property ###### URL /v3/users/{id}/properties/{key}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
key true Key to retrieve string
value true Value to assign string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Trying to modify a non-existent property | - | | 200 | Property modified | - | - - - #### **POST** `/users/{id}/properties/{key}/{value}` ##### createSingle Add a property ###### URL /v3/users/{id}/properties/{key}/{value} ###### Parameters - path
Parameter Required Description Data Type
id true User to fetch properties from string
key true Key to retrieve string
value true Value to assign string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 400 | Trying of adding an already exsisting property - use PUT instead | - | - - - ### /userRoles #### **GET** `/` ##### list List roles ###### URL /v3/ ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **POST** `/` ##### add Add a role ###### URL /v3/ ###### Parameters - path
Parameter Required Description Data Type
name true Role to add string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **DELETE** `/{name}` ##### delete Delete a role ###### URL /v3/{name} ###### Parameters - path
Parameter Required Description Data Type
name true Role to delete string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Role not found | - | - - - ### /userProperties #### **GET** `/` ##### list Get every property ###### URL /v3/ ###### Parameters ###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **PUT** `/` ##### updateAll Modify the whole properties with a new set ###### URL /v3/ ###### Parameters - body
Parameter Required Description Data Type
body false Properties
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **GET** `/{key}` ##### get Get a single property ###### URL /v3/{key} ###### Parameters - path
Parameter Required Description Data Type
key true Key to retrieve string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| - - - #### **PUT** `/{key}/{value}` ##### updateSingle Modify a single property ###### URL /v3/{key}/{value} ###### Parameters - path
Parameter Required Description Data Type
key true Key to retrieve string
value true Value to assign string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 404 | Trying to modify a non-existent property | - | | 200 | Property modified | - | - - - #### **POST** `/{key}/{value}` ##### createSingle Add a property ###### URL /v3/{key}/{value} ###### Parameters - path
Parameter Required Description Data Type
key true Key to retrieve string
value true Value to assign string
###### Response [](#) ###### Errors | Status Code | Reason | Response Model | |-------------|-------------|----------------| | 400 | Trying of adding an already exsisting property - use PUT instead | - | - - - ## Data Types ## Behavior
type required access description notes
boolean optional - - -
string optional - - -
boolean optional - - -
string optional - - -
int optional - - -
## Command
type required access description notes
int optional - - -
string optional - - -
string optional - - -
boolean optional - - -
string optional - - -
boolean optional - - -
int optional - - -
string optional - - -
string optional - - -
Config optional - - -
boolean optional - - -
Set optional - - -
string optional - - -
## Condition
type required access description notes
string optional - - -
Statement optional - - -
## Config
type required access description notes
Tuples optional - - -
string optional - - -
Properties optional - - -
## EnvObject
type required access description notes
string optional - - -
string optional - - -
string optional - - -
string optional - - -
Properties optional - - -
string optional - - -
Representation optional - - -
string optional - - -
string optional - - -
Properties optional - - -
int optional - - -
Array[Behavior] optional - - -
string optional - - -
Map[string,string] optional - - -
string optional - - -
Array[Behavior] optional - - -
Set optional - - -
string optional - - -
Array[Representation] optional - - -
string optional - - -
FreedomShape optional - - -
## Environment
type required access description notes
java.util.ArrayList<com.freedomotic.model.environment.Zone> optional - - -
string optional - - -
string optional - - -
string optional - - -
int optional - - -
string optional - - -
string optional - - -
int optional - - -
FreedomPolygon optional - - -
int optional - - -
FreedomColor optional - - -
## FreedomColor
type required access description notes
int optional - - -
int optional - - -
int optional - - -
int optional - - -
## FreedomPoint
type required access description notes
int optional - - -
int optional - - -
## FreedomPolygon
type required access description notes
java.util.ArrayList<com.freedomotic.model.geometry.FreedomPoint> optional - - -
## Payload
type required access description notes
string optional - - -
Array[Statement] optional - - -
## Properties
type required access description notes
java.util.Collection<V> optional - - -
Set[java.util.Map$Entry<K, V>] optional - - -
boolean optional - - -
Set optional - - -
## ReactionRepresentation
type required access description notes
string optional - - -
string optional - - -
string optional - - -
List[Map[string,string]] optional - - -
string optional - - -
string optional - - -
Array[Condition] optional - - -
## Representation
type required access description notes
boolean optional - - -
string optional - - -
double optional - - -
string optional - - -
FreedomPoint optional - - -
string optional - - -
FreedomShape optional - - -
double optional - - -
string optional - - -
double optional - - -
boolean optional - - -
## Statement
type required access description notes
string optional - - -
string optional - - -
string optional - - -
string optional - - -
## Trigger
type required access description notes
string optional - - -
long optional - - -
int optional - - -
boolean optional - - -
string optional - - -
string optional - - -
int optional - - -
boolean optional - - -
Payload optional - - -
string optional - - -
long optional - - -
long optional - - -
## UserRepresentation
type required access description notes
Set optional - - -
Properties optional - - -
string optional - - -
string optional - - -
## Zone
type required access description notes
boolean optional - - -
string optional - - -
string optional - - -
string optional - - -
FreedomPolygon optional - - -
string optional - - -