DeleteTask
Deletes the specified task. The task's logs will be deleted only if deletetasklogs=true is set.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public void DeleteTask(
string server,
string task,
bool deletetasklogs = false
);
Parameters
Parameter | Type | Description |
---|---|---|
server |
string |
The server where the task is defined. |
task |
string |
The task to be deleted. |
deletetasklogs |
bool |
Whether to delete the task logs or not. |
Errors
Error | Message | Description |
---|---|---|
AEM_TASK_NOT_FOUND |
Replication task {task] on server {server} could not be found. |
Returned if the task name is unknown to Qlik Enterprise Manager. |
AEM_DELETE_TASK_INNER_ERR |
Replication task {task] on server {server} could not be deleted due to an error. |
Returned if Enterprise Manager encounters an error/exception when trying to delete the task. |
AEM_DELETE_TASK_ERR |
Replication task {task] on server {server} could not be deleted due to an error. {2} |
Returned if Enterprise Manager encounters an error when trying to delete the task. |
AEM_TASK_NOT_STOPPED |
Replication task {task] on server {server} must be stopped before it can be deleted. |
Returned if the replication task was running when AemDeleteTask attempted to delete it. |