Control a Task
Pause, resume, or terminate a task by task execution code.
Endpoint Information
Section titled “Endpoint Information”- Name: Pause, resume, or terminate a task
- Description: Pauses, resumes, or terminates a task execution.
- Method:
POST - Path:
remoteApi/taskCtrl - Login required: No
- Permission required: Yes
Note: The robot must be in task mode.
Request Parameters
Section titled “Request Parameters”-
taskExecuteCode·String· RequiredTask execution code returned when the task was issued; see the field examples below.
-
command·String· RequiredControl command:
2pause,3resume,4terminate
Example:2
Field Examples
Section titled “Field Examples”taskExecuteCode
ysc001_1989299475652878336_20251115153307_yiibRequest Example
Section titled “Request Example”{ "taskExecuteCode": "ysc001_2017509386119794688_20260131161003_j9iy", "command": "4"}Response
Section titled “Response”| Field | Type | Example | Description |
|---|---|---|---|
| code | Integer | 200 | Status code |
| success | Boolean | true | Whether the request succeeded |
| msg | String | success | Response message |
Response Example
Section titled “Response Example”{ "success": true, "code": 200, "msg": "Operation succeeded", "data": null}Error Codes
Section titled “Error Codes”| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 401 | Unauthorized |
| 403 | Access denied |
| 404 | Resource not found |
| 500 | Internal server error |