Skip to content

Control a Task

Pause, resume, or terminate a task by task execution code.

  • 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.


  • taskExecuteCode · String · Required

    Task execution code returned when the task was issued; see the field examples below.

  • command · String · Required

    Control command: 2 pause, 3 resume, 4 terminate
    Example: 2

taskExecuteCode

ysc001_1989299475652878336_20251115153307_yiib
{
"taskExecuteCode": "ysc001_2017509386119794688_20260131161003_j9iy",
"command": "4"
}
FieldTypeExampleDescription
codeInteger200Status code
successBooleantrueWhether the request succeeded
msgStringsuccessResponse message
{
"success": true,
"code": 200,
"msg": "Operation succeeded",
"data": null
}
CodeDescription
400Invalid parameters
401Unauthorized
403Access denied
404Resource not found
500Internal server error