get.list.tasks
Syntax
{"jsonrpc":"2.0","method":"get.list.tasks","id": 1}Returns
Returns the complete list of all tasks with the following properties
| Property | Description |
|---|---|
| keyword | Keyword to filter a task |
| name | Name of the task |
| objectType | For this method, this field contains task |
| taskEnable | If the task is enabled/disabled |
| triggerDeviceUuid | uuid of the device set as a trigger, if present |
| triggerEnable | If it is possible to trigger the task |
| triggerParam1-6 | 6 fields of parameters present for the trigger device |
| triggered | Indicate if this task was recently launched (More information coming) |
| uiColor | Color assigned to the task |
| uuid | uuid of the task |
get.object.task
Syntax
{"jsonrpc":"2.0","method":"get.object.task", "params": {"uuid": "{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}"}}Parameters
| Parameter | Description |
|---|---|
| uuid | uuid of the task |
| name | Name of the task |
Returns
Returns the following properties of target task.
| Property | Description |
|---|---|
| keyword | Keyword to filter a task |
| name | Name of the task |
| objectType | For this method, this field contains task |
| taskEnable | If the task is enabled/disabled |
| triggerDeviceUuid | uuid of the device set as a trigger, if present |
| triggerEnable | If it is possible to trigger the task |
| triggerParam1-6 | 6 fields of parameters present for the trigger device |
| triggered | Indicate if this task was recently launched (More information coming) |
| uiColor | Color assigned to the task |
| uuid | uuid of the task |
set.property.task
Syntax
{"jsonrpc":"2.0","method":"set.property.task", "params":{"uuid":"{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}","property":"taskEnable","value":true}}Parameters
Use this command to modify one target property on a task.
It is possible to target the following properties:
| Property | Type | Description |
|---|---|---|
| keyword | String | Keyword to filter a task |
| name | String | Name of the task |
| taskEnable | Boolean | Set to true to enable the task or false to disable the task |
| triggerEnable | Boolean | Set to true to enable the trigger of the task or false to disable the trigger |
| uiColor | String | RGB hexadecimal value for the color of the task. Must be prefixed with the # character |
Returns
The "result" property in the JSON response will contain a boolean : true if the instruction was executed correctly or false otherwise.More information soon.
doaction.task
Syntax
{"jsonrpc":"2.0","method":"doaction.task", "params":{"uuid":"{45c8566e-435d-4abb-ad3a-2800cb1ce1c5}","action":"launch"}}Parameters
Use this command to do an action on a target task.
Currently only the launch action can be sent to trigger the launch of task.
Returns
If the "action" parameter is valid, the JSON will return "result": true.
If tthe "action" parameter is invalid, or specified name or uuid is invalid, the JSON will return a message with "Invalid params".
Need more help with this?
Don’t hesitate to contact us here.