Skip to main content Skip to complementary content

CloneTask

General

URL

https://{Host}/attunityenterprisemanager/api/v1/servers/{ServerName}/tasks/{TaskName}?action=clone

Description

Clones the definitions of the specified task on the specified server. The definitions include the task settings, tables/table patterns (include/exclude), table settings, and global transformations. The endpoint definitions are cloned with the task definition.

Information note
  • You cannot override an existing task with the same name
  • The task being cloned must have a source and target endpoint

HTTP method

POST

Required user role

Operator or above on Qlik Enterprise Manager.

Request parameters

Request parameters
Location Name Required Description

URL

Host [string]

Yes

The host name of the Qlik Enterprise Manager server.

Example: computer.network.net

URL

ServerName [string]

Yes

The Replicate Server name as defined in Qlik Enterprise Manager.

Example: myrepsrv1

URL

TaskName [string]

Yes

The name of the Replicate task to clone.

Header

EnterpriseManager.APISessionID [string]

Yes

wCo0_KvjEUFROvfHF5KGrw

Header

Content-Length:

This is the number of bytes in the content body.

Note that the number of bytes that you specify must be exactly the same as the number of bytes in the JSON file. This number can be ascertained by copy-pasting the text into a text editor such as Notepad ++ (which shows the number of bytes as "Length" at the bottom of its console).

Yes

"Content-Length: 3986"

Body (JSON file) clone_permissions No Stipulates whether to clone the task permissions. The value can be true of false. The default is false, meaning that if this parameter is omitted, the permissions will not be cloned.
Body (JSON file) new_task_name Yes The new name of the task after it has been cloned.
Body (JSON file) new_source_endpoint No

The display name of the source endpoint. The display name must already exist on the Replicate Server.

Information noteThe display name must be of an endpoint of the same type used in the task being cloned. For example, if the source endpoint in the task being cloned is of type Oracle, you cannot specify MyNewSource if it is the display name of a Microsoft SQL Server endpoint.
Body (JSON file) new_target_endpoint No

The display name of the target endpoint. The display name must already exist on the Replicate Server.

Information noteThe display name must be of an endpoint of the same type used in the task being cloned. For example, if the target endpoint in the task being cloned is of type Oracle, you cannot specify MyNewTarget if it is the display name of a Microsoft SQL Server endpoint.
Body (JSON file) new_control_schema No The new name of the schema in which to create the control tables.
Body (JSON file) new_target_schema No The new name of the schema in which to create the target tables.
Body (JSON file) new_control_table_tablespace No

The new name of the tablespace in which to create the control tables.

Information noteRelevant when replicating to an Oracle target only.
Body (JSON file) new_control_index_tablespace No

The new name of the tablespace in which to create the control table indexes.

Information noteRelevant when replicating to an Oracle target only.

cURL example

Request

curl -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" https://computer.network.net/attunityenterprisemanager/api/v1/servers/ myrepsrv1/tasks/SalesDBBackup?action=clone

{
	"clone_permissions":true,
	"new_task_name":"BusinessData",
	"new_source_endpoint":"MyOracle",
	"new_target_endpoint":"MySQLServer",
	"new_control_schema":"TaskControlSchema",
	"new_target_schema":"TaskTargetSchema",
	"new_control_table_tablespace":"TaskTableSpace",
	"new_control_index_tablespace":"TaskIndexTableSpace"
}

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!

OSZAR »