{{sidenavigation.sidenavigationExpandLabel}}
{{getMsg('Help_YouAreHere')}}: {{page.title}} {{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}} {{helpModel.downloadHelpPdfDataStatus}}

Execute

Schedules immediate execution of the task specified by ID. Request will take no effect if task is already scheduled for execution or is being executed. Tasks can be scheduled from their JSON representation as well.

GET /api/taskplanner/<TaskID>/execute

Requests immediate execution of a task. The response is the GUID of the executed job. The GUID can be used to request details.

Example Request

# Request
# Use user:password for authorization
GET /api/taskplanner/4w8yavnk046debwrwkcg4dbqh/execute HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response - Task is scheduled for execution
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <CONTENT LENGTH>
 
"4w8yavnk046debwrwkcg4dbqh"
# Request
# Use user:password for authorization
GET /api/taskplanner/4w8yavnk046debwrwkcg4dbqh/execute HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response - Task does not exist
HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: <CONTENT LENGTH>
 
{
  "error": "An answer could not be found: Task does not exist, taskID = 4w8yavnk046debwrwkcg4dbqh"
}

Application Example

# Browser access
http://127.0.0.1:9000/api/taskplanner/4w8yavnk046debwrwkcg4dbqh/execute
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "http://127.0.0.1:9000/api/taskplanner/4w8yavnk046debwrwkcg4dbqh/execute"
 
# Shell access using curl using username and password
curl -Lsu username:password "http://127.0.0.1:9000/api/taskplanner/4w8yavnk046debwrwkcg4dbqh/execute"
i-net CoWork
This application uses cookies to allow login. By continuing to use this application, you agree to the use of cookies.


Help - /<TaskID>/execute