DeleteTask

HTTP Request Formats

DELETE api/task

DELETE api/task/{taskName}

To specify the schedule the command shall be sent to:

DELETE api/schedule/{scheduleName}/task

DELETE api/schedule/{scheduleName}/task/{taskName}

The DeleteTask REST API command deletes the specified tasks in the schedule.

Parameters are only used if the task name is not specified in the HTTP request

JSON Parameters	Body Format	Description
Id	"Id" : "Task1"	Parameter is a string of a single task name. Wildcards are allowed
IdList	"IdList": ["Task1","Task2","Task3"]	Parameter is a string of text in single quotes of a comma delimited list of task names. Wildcards are allowed
All	"All : "TRUE"	Optional boolean will delete all tasks within the schedule
Unassigned	"Unassigned" : "TRUE"	Optional boolean will remove all single instance tasks that are not assigned. This excludes any parent task definitions (recurring parent or template parent task definitions).

Deletes the task DemoTask1 and DemoTask2 from the active schedule
DELETE api/task

Body:

{

"IdList" : ["DemoTask1", "DemoTask2"]

}

If activated, a standard response for a successful HTTP response shall appear.

This command belongs to the following group(s):

12.3