Skip to main content Skip to complementary content

DeleteTask

General

URL

https[host]/attunityenterprisemanager/api/v1/servers/[server]/tasks/[task]?action=delete&deletetasklogs=[deletetasklogs]

Description

Deletes the specified task. The task's logs will be deleted only if deletetasklogs=true is specified in the URL.

HTTP method

POST

Required user role

See Required Enterprise Manager permissions.

Request parameters

Request parameters
Location Name Required Example

URL

host [string]

Yes

computer.network.net

URL

ServerName [string]

Yes

myrepsrv1

URL

TaskName [string]

Yes

SalesDBBackup

URL

deletetasklogs [bool]

Optional (default is false)

deletetasklogs=true

Header

EnterpriseManager.APISessionID [string]

Yes

wCo0_KvjEUFROvfHF5KGrw

Header

Content-Length:

Yes

"Content-Length: 0"

Note: The specified value must be "0".

cURL example

Request

curl -i -k -X POST --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" --header "Content-Length: 0"
https:// computer.network.net/attunityenterprisemanager/api/v1/
servers/myrepsrv1/tasks/ SalesDBBackup?action=delete&deletetasklogs=true

Response

Header:

HTTP/1.1 200 OK

Cache-Control: no-cache, no-store

Content-Length: 38

Content-Type: application/json; charset=utf-8

Server: Microsoft-HTTPAPI/2.0

Date: Mon, 26 Dec 2016 16:31:01 GMT

Error response

Error responses
HTTP Code Enterprise Manager Code Text Description

500

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.

500

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.

500

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.

500

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 DeleteTask attempted to delete it.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!