data.swagger.apidocs.strapdown.html Maven / Gradle / Ivy
The newest version!
#
BasePath: /v3
Api Version: v3
## APIs
### /marketPlacePlugins
#### **GET** `/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
### /marketplaceProviders
#### **GET** `/{id}`
##### get
Show info about specific provider
###### URL
/v3/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/{id}/update`
##### update
Update provider's data - reload data from it
###### URL
/v3/{id}/update
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/{id}/upgrade`
##### upgrade
Upgrade plugins with most recent version available on a marketplace
###### URL
/v3/{id}/upgrade
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/categories/{cat}`
##### get
Get a category basic data
###### URL
/v3/{id}/categories/{cat}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/categories`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/{id}/categories
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/categories/{cat}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/{id}/categories/{cat}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/categories/{cat}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/{id}/categories/{cat}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/{id}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{id}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/{id}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/{id}/plugins/install/{nid}`
##### installPlugin
Download and install a plugin, given its node id
###### URL
/v3/{id}/plugins/install/{nid}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
nid
true
Node id of plugin to install - this is a id relative to selected provider
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 202 | Plugin installation succeded | - |
- - -
### /environments
#### **POST** `/environments/{id}/objects/{id}/click`
##### click
Send a ObjectClickEvent for related object
###### URL
/v3/environments/{id}/objects/{id}/click
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to click
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/objects/{id}/behaviorchange/{bid}/{value}`
##### behaviorChange
Fire a behavior change request, using provided data
###### URL
/v3/environments/{id}/objects/{id}/behaviorchange/{bid}/{value}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object 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/{id}/objects/templates`
##### listTemplates
List all object templates
###### URL
/v3/environments/{id}/objects/templates
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/objects/templates/{name}/instantiate`
##### instantiateTemplate
Add a new object, based on selected template
###### URL
/v3/environments/{id}/objects/templates/{name}/instantiate
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
name
true
Name of object template (e.g. Light, Thermostat)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Template not found | - |
| 201 | Object added | - |
- - -
#### **POST** `/environments/{id}/rooms/{id}/objects/{id}/click`
##### click
Send a ObjectClickEvent for related object
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/click
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to click
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/rooms/{id}/objects/{id}/behaviorchange/{bid}/{value}`
##### behaviorChange
Fire a behavior change request, using provided data
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviorchange/{bid}/{value}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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/{id}/rooms/{id}/objects/templates`
##### listTemplates
List all object templates
###### URL
/v3/environments/{id}/rooms/{id}/objects/templates
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/rooms/{id}/objects/templates/{name}/instantiate`
##### instantiateTemplate
Add a new object, based on selected template
###### URL
/v3/environments/{id}/rooms/{id}/objects/templates/{name}/instantiate
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
name
true
Name of object template (e.g. Light, Thermostat)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Template not found | - |
| 201 | Object added | - |
- - -
#### **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 | - |
- - -
#### **GET** `/environments/{id}/objects`
##### list
List all objects
###### URL
/v3/environments/{id}/objects
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/objects`
##### create
Add a new object
###### URL
/v3/environments/{id}/objects
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New object created | - |
- - -
#### **GET** `/environments/{id}/objects/{id}/behaviors`
##### list
Get a list of items
###### URL
/v3/environments/{id}/objects/{id}/behaviors
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/objects/{id}/behaviors`
##### create
Create a new item
###### URL
/v3/environments/{id}/objects/{id}/behaviors
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New item created | - |
- - -
#### **GET** `/environments/{id}/rooms`
##### list
List all rooms
###### URL
/v3/environments/{id}/rooms
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/rooms`
##### create
Add a new room
###### URL
/v3/environments/{id}/rooms
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Zone
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New room added | - |
- - -
#### **GET** `/environments/{id}/rooms/{id}/objects/`
##### list
List all objects
###### URL
/v3/environments/{id}/rooms/{id}/objects/
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/rooms/{id}/objects/`
##### create
Add a new object
###### URL
/v3/environments/{id}/rooms/{id}/objects/
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New object created | - |
- - -
#### **GET** `/environments/{id}/rooms/{id}/objects/{id}/behaviors`
##### list
Get a list of items
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/environments/{id}/rooms/{id}/objects/{id}/behaviors`
##### create
Create a new item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### 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
- body
Parameter
Required
Description
Data Type
body
false
Environment
- path
Parameter
Required
Description
Data Type
id
true
UUID of environment to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### 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}/objects/{id}`
##### get
Get an object
###### URL
/v3/environments/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **PUT** `/environments/{id}/objects/{id}`
##### update
Update an object
###### URL
/v3/environments/{id}/objects/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Object not modified | - |
- - -
#### **DELETE** `/environments/{id}/objects/{id}`
##### delete
Delete an object
###### URL
/v3/environments/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **GET** `/environments/{id}/objects/{id}/behaviors/{id}`
##### get
Get a single item
###### URL
/v3/environments/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/behaviors/{id}`
##### update
Update an item
###### URL
/v3/environments/{id}/objects/{id}/behaviors/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
id
true
ID of item to update
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Item not modified | - |
- - -
#### **DELETE** `/environments/{id}/objects/{id}/behaviors/{id}`
##### delete
Delete an item
###### URL
/v3/environments/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object 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}/rooms/{id}`
##### get
Get a room
###### URL
/v3/environments/{id}/rooms/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
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
- body
Parameter
Required
Description
Data Type
body
false
Zone
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Room not modified | - |
- - -
#### **DELETE** `/environments/{id}/rooms/{id}`
##### delete
Delete a room object
###### URL
/v3/environments/{id}/rooms/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
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}/objects/{id}`
##### get
Get an object
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **PUT** `/environments/{id}/rooms/{id}/objects/{id}`
##### update
Update an object
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Object not modified | - |
- - -
#### **DELETE** `/environments/{id}/rooms/{id}/objects/{id}`
##### delete
Delete an object
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **GET** `/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}`
##### get
Get a single item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/behaviors/{id}`
##### update
Update an item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
id
true
ID of item to update
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Item not modified | - |
- - -
#### **DELETE** `/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}`
##### delete
Delete an item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/behaviors/{id}/copy`
##### copy
Copy an item
###### URL
/v3/environments/{id}/objects/{id}/behaviors/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/copy`
##### copy
Copy an item
###### URL
/v3/environments/{id}/objects/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch objects 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}/objects/{id}/behaviors/{id}/copy`
##### copy
Copy an item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/behaviors/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/copy`
##### copy
Copy an item
###### URL
/v3/environments/{id}/rooms/{id}/objects/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Environment to fetch rooms from
string
id
true
UUID of room to fetch objects 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
Environment to fetch rooms 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}/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
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
ID of item to update
string
###### 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
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
ID of item to update
string
###### 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 | - |
- - -
### /marketplaceCategory
#### **GET** `/{cat}`
##### get
Get a category basic data
###### URL
/v3/{cat}
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{cat}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/{cat}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/{cat}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/{cat}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
### /rooms
#### **POST** `/rooms/{id}/objects/{id}/click`
##### click
Send a ObjectClickEvent for related object
###### URL
/v3/rooms/{id}/objects/{id}/click
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to click
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/rooms/{id}/objects/{id}/behaviorchange/{bid}/{value}`
##### behaviorChange
Fire a behavior change request, using provided data
###### URL
/v3/rooms/{id}/objects/{id}/behaviorchange/{bid}/{value}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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/{id}/objects/templates`
##### listTemplates
List all object templates
###### URL
/v3/rooms/{id}/objects/templates
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/rooms/{id}/objects/templates/{name}/instantiate`
##### instantiateTemplate
Add a new object, based on selected template
###### URL
/v3/rooms/{id}/objects/templates/{name}/instantiate
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
name
true
Name of object template (e.g. Light, Thermostat)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Template not found | - |
| 201 | Object added | - |
- - -
#### **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
Zone
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New room added | - |
- - -
#### **GET** `/rooms/{id}/objects/`
##### list
List all objects
###### URL
/v3/rooms/{id}/objects/
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/rooms/{id}/objects/`
##### create
Add a new object
###### URL
/v3/rooms/{id}/objects/
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New object created | - |
- - -
#### **GET** `/rooms/{id}/objects/{id}/behaviors`
##### list
Get a list of items
###### URL
/v3/rooms/{id}/objects/{id}/behaviors
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/rooms/{id}/objects/{id}/behaviors`
##### create
Create a new item
###### URL
/v3/rooms/{id}/objects/{id}/behaviors
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
###### 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
- body
Parameter
Required
Description
Data Type
body
false
Zone
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Room not modified | - |
- - -
#### **DELETE** `/rooms/{id}`
##### delete
Delete a room object
###### 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}/objects/{id}`
##### get
Get an object
###### URL
/v3/rooms/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **PUT** `/rooms/{id}/objects/{id}`
##### update
Update an object
###### URL
/v3/rooms/{id}/objects/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Object not modified | - |
- - -
#### **DELETE** `/rooms/{id}/objects/{id}`
##### delete
Delete an object
###### URL
/v3/rooms/{id}/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **GET** `/rooms/{id}/objects/{id}/behaviors/{id}`
##### get
Get a single item
###### URL
/v3/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/behaviors/{id}`
##### update
Update an item
###### URL
/v3/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object to fetch behaviors from
string
id
true
ID of item to update
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Item not modified | - |
- - -
#### **DELETE** `/rooms/{id}/objects/{id}/behaviors/{id}`
##### delete
Delete an item
###### URL
/v3/rooms/{id}/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/behaviors/{id}/copy`
##### copy
Copy an item
###### URL
/v3/rooms/{id}/objects/{id}/behaviors/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects from
string
id
true
UUID of object 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}/objects/{id}/copy`
##### copy
Copy an item
###### URL
/v3/rooms/{id}/objects/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of room to fetch objects 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 | - |
- - -
### /objects
#### **POST** `/objects/{id}/click`
##### click
Send a ObjectClickEvent for related object
###### URL
/v3/objects/{id}/click
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to click
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/objects/{id}/behaviorchange/{bid}/{value}`
##### behaviorChange
Fire a behavior change request, using provided data
###### URL
/v3/objects/{id}/behaviorchange/{bid}/{value}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to click
string
bid
true
name of behavior
string
value
true
desired value of behavior
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/objects/templates`
##### listTemplates
List all object templates
###### URL
/v3/objects/templates
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/objects/templates/{name}/instantiate`
##### instantiateTemplate
Add a new object, based on selected template
###### URL
/v3/objects/templates/{name}/instantiate
###### Parameters
- path
Parameter
Required
Description
Data Type
name
true
Name of object template (e.g. Light, Thermostat)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Template not found | - |
| 201 | Object added | - |
- - -
#### **GET** `/objects`
##### list
List all objects
###### URL
/v3/objects
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/objects`
##### create
Add a new object
###### URL
/v3/objects
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New object created | - |
- - -
#### **GET** `/objects/{id}/behaviors`
##### list
Get a list of items
###### URL
/v3/objects/{id}/behaviors
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/objects/{id}/behaviors`
##### create
Create a new item
###### URL
/v3/objects/{id}/behaviors
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to fetch behaviors from
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New item created | - |
- - -
#### **GET** `/objects/{id}`
##### get
Get an object
###### URL
/v3/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **PUT** `/objects/{id}`
##### update
Update an object
###### URL
/v3/objects/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
EnvObject
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Object not modified | - |
- - -
#### **DELETE** `/objects/{id}`
##### delete
Delete an object
###### URL
/v3/objects/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Object not found | - |
- - -
#### **GET** `/objects/{id}/behaviors/{id}`
##### get
Get a single item
###### URL
/v3/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object 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** `/objects/{id}/behaviors/{id}`
##### update
Update an item
###### URL
/v3/objects/{id}/behaviors/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
UUID of object to fetch behaviors from
string
id
true
ID of item to update
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | Item not modified | - |
- - -
#### **DELETE** `/objects/{id}/behaviors/{id}`
##### delete
Delete an item
###### URL
/v3/objects/{id}/behaviors/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object 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** `/objects/{id}/behaviors/{id}/copy`
##### copy
Copy an item
###### URL
/v3/objects/{id}/behaviors/{id}/copy
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
UUID of object 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** `/objects/{id}/copy`
##### copy
Copy an item
###### URL
/v3/objects/{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
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
- body
Parameter
Required
Description
Data Type
body
false
ReactionRepresentation
- path
Parameter
Required
Description
Data Type
id
true
UUID of reaction to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### 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 | - |
- - -
#### **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
- body
Parameter
Required
Description
Data Type
body
false
Trigger
- path
Parameter
Required
Description
Data Type
id
true
UUID of trigger to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### 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 an 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 |
|-------------|-------------|----------------|
- - -
#### **GET** `/commands/user`
##### list
List all user 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
Command
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New user's command added | - |
- - -
#### **GET** `/commands/user/{id}`
##### get
Get an 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 an user's command
###### URL
/v3/commands/user/{id}
###### Parameters
- body
Parameter
Required
Description
Data Type
body
false
Command
- path
Parameter
Required
Description
Data Type
id
true
UUID of user's command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 304 | User's command not modified | - |
- - -
#### **DELETE** `/commands/user/{id}`
##### delete
Delete an 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
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
- body
Parameter
Required
Description
Data Type
body
false
Command
- path
Parameter
Required
Description
Data Type
id
true
UUID of hardware command to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)
string
###### 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
- body
Parameter
Required
Description
Data Type
body
false
Object
- path
Parameter
Required
Description
Data Type
id
true
ID of item to update
string
###### 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
- query
Parameter
Required
Description
Data Type
fbId
false
Name of alternate image file to fetch
string
- path
Parameter
Required
Description
Data Type
id
true
Name of image file to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 404 | Image not found | - |
- - -
### /marketplace
#### **GET** `/marketplace/categories/{cat}`
##### get
Get a category basic data
###### URL
/v3/marketplace/categories/{cat}
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/categories`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/categories
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/categories/{cat}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/marketplace/categories/{cat}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/categories/{cat}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/categories/{cat}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}`
##### get
Show info about specific provider
###### URL
/v3/marketplace/providers/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/providers
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/marketplace/providers/{id}/update`
##### update
Update provider's data - reload data from it
###### URL
/v3/marketplace/providers/{id}/update
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/marketplace/providers/{id}/upgrade`
##### upgrade
Upgrade plugins with most recent version available on a marketplace
###### URL
/v3/marketplace/providers/{id}/upgrade
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/categories/{cat}`
##### get
Get a category basic data
###### URL
/v3/marketplace/providers/{id}/categories/{cat}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/categories`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/providers/{id}/categories
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/categories/{cat}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/marketplace/providers/{id}/categories/{cat}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/categories/{cat}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/providers/{id}/categories/{cat}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
cat
true
Name of plugins category to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/marketplace/providers/{id}/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/providers/{id}/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/providers/{id}/plugins
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/marketplace/providers{id}/plugins/install/{nid}`
##### installPlugin
Download and install a plugin, given its node id
###### URL
/v3/marketplace/providers{id}/plugins/install/{nid}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Index of marketplace provider
int
nid
true
Node id of plugin to install - this is a id relative to selected provider
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 202 | Plugin installation succeded | - |
- - -
#### **POST** `/marketplace/update`
##### update
Update providers' data - reload data from all of them
###### URL
/v3/marketplace/update
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/plugins/{id}`
##### get
Get a single plugin package metadata
###### URL
/v3/marketplace/plugins/{id}
###### Parameters
- path
Parameter
Required
Description
Data Type
id
true
Name of plugin to fetch
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **GET** `/marketplace/plugins`
##### list
Show the list of registered remote marketplace providers
###### URL
/v3/marketplace/plugins
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/marketplace/upgrade`
##### upgrade
Upgrade plugins with most recent version available on marketplaces
###### URL
/v3/marketplace/upgrade
###### Parameters
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/marketplace/plugins/install/{url}`
##### installPlugin
Download and install a plugin
###### URL
/v3/marketplace/plugins/install/{url}
###### Parameters
- path
Parameter
Required
Description
Data Type
url
true
URL of plugin to download and install - this have to be url-encoded
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 202 | Plugin installation succeded | - |
- - -
### /system
#### **POST** `/system/exit`
##### exit
Initiate shutdown procedure
###### URL
/v3/system/exit
###### 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/messaging`
##### listMessaginsSettings
Show information about the messaging system
###### URL
/v3/system/info/messaging
###### 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/_/login`
##### login
Get current user
###### URL
/v3/users/_/login
###### Parameters
- form
Parameter
Required
Description
Data Type
name
false
string
password
false
string
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
- - -
#### **POST** `/users/_/logout`
##### logout
Get current user
###### URL
/v3/users/_/logout
###### Parameters
###### 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}/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`
##### 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
UserRepresentation
###### Response
[](#)
###### Errors
| Status Code | Reason | Response Model |
|-------------|-------------|----------------|
| 201 | New user added | - |
- - -
#### **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
- body
Parameter
Required
Description
Data Type
body
false
Properties
- path
Parameter
Required
Description
Data Type
id
true
User to fetch properties from
string
###### 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}`
##### 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
- body
Parameter
Required
Description
Data Type
body
false
UserRepresentation
- path
Parameter
Required
Description
Data Type
id
true
User to update (e.g. admin, guest)
string
###### 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
-
-
-
boolean
optional
-
-
-
boolean
optional
-
-
-
string
optional
-
-
-
int
optional
-
-
-
Config
optional
-
-
-
string
optional
-
-
-
string
optional
-
-
-
boolean
optional
-
-
-
java.util.HashSet<java.lang.String>
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
-
-
-
java.util.ArrayList<com.freedomotic.model.object.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
-
-
-
## Properties
type
required
access
description
notes
java.util.Collection<V>
optional
-
-
-
Set[java.util.Map.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
-
-
-
© 2015 - 2024 Weber Informatics LLC | Privacy Policy