Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET outputs/command/start/{encoder_id}/{device_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Starts the desired encoder on a specific device in the stack, if defined.
Resource URL
http://{host}/api/2.0/outputs/command/start/{encoder_id}/{device_id}/.format
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"Task": {
"id": 233046,
"device_id": 9011,
"type": "Toggle Encoder State",
"type_id": 17,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1612535089416"
}
} |
GET outputs/command/stop/{encoder_id}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Stops an active encoder.
Resource URL
http://{host}/api/2.0/outputs/command/stop/{encoder_id}/.format
Parameters
Parameter | Data Type | Description |
|---|---|---|
encoder_id | integer | The ID of the desired encoder. |
Example Request
GET
| Code Block | ||
|---|---|---|
| ||
{
"Task": {
"id": 290706,
"device_id": 9011,
"type": "Toggle Encoder State",
"type_id": 17,
"mode": "Starting",
"mode_id": 1,
"status": null,
"description": null,
"total": 0,
"completed": 0,
"time_remained": 0,
"modified": "1612535003126"
}
} |