PatchTask

General

Description

Use to get task settings and modify settings of existing tasks.

Method

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
Header	EnterpriseManager.APISessionID [string]	Yes	wCo0_KvjEUFROvfHF5KGrw

Body requests

The body should be in JSON format and determine:

Setting values that will be changed
Settings that will be disabled

As the API reflects the behavior and functionality of the Replicate UI, some settings require certain parent settings to be enabled before they can be modified. For example, it is not possible to enable the Optimize handling when LOB size is less than option when the Replicate LOB columns option is disabled. Therefore, if you are not sure whether the parent settings are enabled, to prevent errors, best practice is to include operations for enabling the parent settings in the request body as well. Examples of how to do this are provided below.

To verify a command in the Replicate console, you must first refresh your browser.

Changing a setting value

Syntax

The syntax for changing a setting value is as follows:

[
	{ "op": "add", "path": "full path to setting", "value": new-value }
]

Example

The following example shows how to change the Maximum number of tables setting in the Full Load Tuning tab.

[
	{ "op": "add", "path": "/full_load_sub_tasks", "value": 100 }
]

Reverting to the default setting value

You revert a setting to its default value by using the "remove" command. If the setting is dependent on other settings being enabled, you also need to enable those settings before you can revert the specific setting to its default. If you are aware that the related settings are already enabled, then you can simply use the "remove" operation.

Example

In the following example, the user wants to revert the Chunk size (KB) (lob_chunk_size) setting to its default value. Changing this setting or restoring its default requires the Replicate LOB columns and Allow unlimited LOB size settings to be enabled. Because the user is not sure they are enabled, he includes operations for enabling them in the request body.

[
	{ "op": "add", "path": "/common_settings/support_lobs", "value": true },
	{ "op": "add", "path": "/common_settings/lob_max_size", "value": 0 },
	{ "op": "remove", "path": "/common_settings/lob_chunk_size" }
]

If the user knew beforehand that the Replicate LOB columns and Allow unlimited LOB size settings were enabled, he would only need to include the "remove" operation in the request body.

[
	{ "op": "remove", "path": "/common_settings/lob_chunk_size" }
]

Enabling or disabling a setting (the equivalent of selecting or clearing a check box)

You enable a setting using the "add" operation. You can disable a setting using the "remove" operation or by setting the value to "false".

Enabling a setting

Syntax

The syntax for enabling a setting is as follows:

[
	{ "op": "add", "path": "path_to_setting", "value": true }
]

Example

To enable the Replicate LOB columns option:

[
	{ "op": "add", "path": "/common_settings/support_lobs", "value": true }
]

Disabling a setting using the "remove" operation

Syntax

The syntax for disabling a setting using the "remove" operation is as follows:

[
	{ "op": "remove", "path": "path_to_setting" }
]

Example

To disable the Replicate LOB columns option:

[
	{ "op": "remove", "path": "/common_settings/support_lobs" }
]

Disabling a setting by setting its value to "false"

Syntax

The syntax for disabling a setting by setting its value to "false" is as follows:

[
	{ "op": "add", "path": "path_to_setting", "value": false }
]

Example

To disable the Replicate LOB columns option:

[
	{ "op": "add", "path": "/common_settings/support_lobs", "value": false }
]

Modifying settings

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent	Body with examples
Replicate LOB columns	Enable LOB column replication: `[ { "op": "add", "path": "/common_settings/support_lobs", "value": true } ]` Disable LOB column replication: `[ { "op": "remove", "path": "/common_settings/support_lobs" } ]`
Allow unlimited LOB size	Set the Limit LOB size to (KB) value to 0: `[ { "op": "add", "path": "/common_settings/support_lobs", "value": true }, { "op": "add", "path": "/common_settings/lob_max_size", "value": 0 } ]`
Optimize handling when LOB size is less than	Enable by setting a Optimize handling when LOB size is less than (inline_lob_max_size) value: `[ { "op": "add", "path": "/common_settings/support_lobs", "value": true }, { "op": "add", "path": "/common_settings/lob_max_size", "value": 0 }, { "op": "add", "path": "/common_settings/inline_lob_max_size" , "value": 1 } ]`
Chunk size (KB)	Override the default Chunk size (lob_chunk_size): `[ { "op": "add", "path": "/common_settings/support_lobs", "value": true }, { "op": "add", "path": "/common_settings/lob_max_size", "value": 0 }, { "op": "add", "path": "/common_settings/lob_chunk_size" , "value": 100 } ]`
Limit LOB size to (KB)	Set Limit LOB size to (KB) (lob_max_size) to a value greater than 0. `[ { "op": "add", "path": "/common_settings/support_lobs", "value": true }, { "op": "add", "path": "/common_settings/lob_max_size", "value": 44 } ]`
Target table schema	Set a new Target table schema (default_schema): `[ { "op": "add", "path": "/target_settings/default_schema", "value": "NewTargetSchema" } ]`

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent	Body with examples
Create target control tables in schema	Set a Create target control tables in schema (control_schema) value: `[ { "op": "add", "path": "/target_settings/control_schema", "value": "Oracle2Oracle" } ]`
Create target control tables in tablespace	Set a Create target control tables in tablespace (control_table_tablespace) value: `[ { "op": "add", "path": "/target_settings/control_table_tablespace", "value": "Oracle2Oracle" } ]`
Create target control table indexes in tablespace	Set a Create target control table indexes in tablespace (control_index_tablespace) value: `[ { "op": "add", "path": "/target_settings/control_index_tablespace", "value": "Oracle2Oracle" } ]`
Replication Status	Create the Replication Status control table on the target: `[ { "op": "add", "path": "/common_settings/status_table_enabled", "value": true } ]`
Update Every (Minutes)	Specify an Update Every (Minutes) value: `[ { "op": "add", "path": "/common_settings/status_table_enabled", "value": true }, { "op": "add", "path": "/sorter_settings/status_table_update_interval_seconds", "value": 1440 } ]`
Suspended Tables	Create the Suspended Tables control table on the target: `[ { "op": "add", "path": "/common_settings/suspended_tables_table_enabled", "value": true } ]`
Replication History	Create the Replication History control table on the target: `[ { "op": "add", "path": "/common_settings/history_table_enabled", "value": true } ]`
Update Every (Minutes)	Specify an Update Every (Minutes) value: `[ { "op": "add", "path": "/common_settings/history_table_enabled", "value": true }, { "op": "add", "path": "/common_settings/history_timeslot", "value": 24 } ]`
DDL History	Create the DDL History control table on the target: `[ { "op": "add", "path": "/common_settings/ddl_history_table_enabled", "value": true } ]`
Change Data Partitions	Create the Change Data Partitions control table on the target: `[ { "op": "add", "path": "/common_settings/change_data_batching_table_enabled", "value": true } ]`

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent	Body with examples
Maximum number of tables	Set a "Maximum number of tables" value: `[ { "op": "add", "path": "/full_load_sub_tasks", "value": 100 } ]`

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent Body with examples

Store Changes

UI equivalent	Body with examples
Store Changes	Enable Store Changes (save_changes_enabled): `[ { "op": "add", "path": "/common_settings/save_changes_enabled", "value": true } ]`
On UPDATE	Set On UPDATE: Store after image only (skip_before_image): `[ { "op": "add", "path": "/common_settings/change_table_settings/skip_before_image", "value": true } ]` Set On UPDATE: Store before and after image (skip_before_image): `[ { "op": "add", "path": "/common_settings/change_table_settings/skip_before_image", "value": false } ]`
Change Data Partitioning: Partition every	Enable Change Data Partitioning with the default partitioning interval (one hours): `[ { "op": "add", "path": "/common_settings/save_changes_enabled", "value": true }, { "op": "add", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name", "value": true }, { "op": "add", "path": "/common_settings/data_batching_settings/trigger_mode", "value": "DATA_BATCH_TRIGGER_INTERVAL" }, { "op": "add", "path": "/common_settings/change_data_batching_table_enabled", "value": true } ]` Disable Change Data Partitioning: `[ { "op": "remove", "path": "/common_settings/save_changes_enabled" }, { "op": "remove", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name" }, { "op": "remove", "path": "/common_settings/data_batching_settings/trigger_mode" }, { "op": "remove", "path": "/common_settings/change_data_batching_table_enabled" } ]` Specify a "Partitioning base time" time value: [ { "op": "add", "path": "/common_settings/save_changes_enabled", "value": true }, { "op": "add", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name", "value": true }, { "op": "add", "path": "/common_settings/data_batching_settings/trigger_mode", "value": "DATA_BATCH_TRIGGER_INTERVAL" }, { "op": "add", "path": "/common_settings/data_batching_settings/interval_hours", "value": 2 }, { "op": "add", "path": "/common_settings/data_batching_settings/start_hour", "value": 3 }, { "op": "add", "path": "/common_settings/data_batching_settings/start_minute", "value": 30 }, { "op": "add", "path": "/common_settings/change_data_batching_table_enabled", "value": true } ]

Enable Store Changes (save_changes_enabled):

[
	{ "op": "add", "path": "/common_settings/save_changes_enabled", "value": true }
]

On UPDATE

Set On UPDATE: Store after image only (skip_before_image):

[
	{ "op": "add", "path": "/common_settings/change_table_settings/skip_before_image", "value": true }
]

Set On UPDATE: Store before and after image (skip_before_image):

[
	{ "op": "add", "path": "/common_settings/change_table_settings/skip_before_image", "value": false }
]

Change Data Partitioning: Partition every

Enable Change Data Partitioning with the default partitioning interval (one hours):

[
	{ "op": "add", "path": "/common_settings/save_changes_enabled", "value": true },
	{ "op": "add", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name", "value": true },
	{ "op": "add", "path": "/common_settings/data_batching_settings/trigger_mode", "value": "DATA_BATCH_TRIGGER_INTERVAL" },
	{ "op": "add", "path": "/common_settings/change_data_batching_table_enabled", "value": true }
]

Disable Change Data Partitioning:

[
	{ "op": "remove", "path": "/common_settings/save_changes_enabled" },
	{ "op": "remove", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name" },
	{ "op": "remove", "path": "/common_settings/data_batching_settings/trigger_mode" },
	{ "op": "remove", "path": "/common_settings/change_data_batching_table_enabled" }
]

Specify a "Partitioning base time" time value:

[
	{ "op": "add", "path": "/common_settings/save_changes_enabled", "value": true },
	{ "op": "add", "path": "/common_settings/change_table_settings/header_columns_settings/batch_name", "value": true },
	{ "op": "add", "path": "/common_settings/data_batching_settings/trigger_mode", "value": "DATA_BATCH_TRIGGER_INTERVAL" },
	{ "op": "add", "path": "/common_settings/data_batching_settings/interval_hours", "value": 2 },
	{ "op": "add", "path": "/common_settings/data_batching_settings/start_hour", "value": 3 },
	{ "op": "add", "path": "/common_settings/data_batching_settings/start_minute", "value": 30 },
	{ "op": "add", "path": "/common_settings/change_data_batching_table_enabled", "value": true }
]

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent Body with examples

Change Processing Mode

UI equivalent	Body with examples
Change Processing Mode	Switch to "Transactional apply" `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false } ]` Switch to "Batch optimized apply" `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": true } ]`

Switch to "Transactional apply"

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }
]

Switch to "Batch optimized apply"

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": true }
]

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent Body with examples

Batch Tuning

UI equivalent	Body with examples
Batch Tuning	Change the "Apply batched changes in intervals: Longer than (seconds)" value `[ { "op": "add", "path": "/common_settings/batch_apply_timeout_min", "value": 24 } ]` Return to the default "Apply batched changes in intervals: Longer than (seconds)" value `[ { "op": "remove", "path": "/common_settings/batch_apply_timeout_min" } ]` Change the "Apply batched changes in intervals: But less than (seconds)" value `[ { "op": "add", "path": "/common_settings/batch_apply_timeout", "value": 24 } ]` Return to the default "Longer than (seconds)" and "But less than (seconds)" values `[ { "op": "remove", "path": "/common_settings/batch_apply_timeout" } ]` Override the default "Force apply a batch when processing memory exceeds (MB)" value `[ { "op": "add", "path": "/common_settings/batch_apply_memory_limit", "value": 24 } ]` Return to the default "Force apply a batch when processing memory exceeds (MB)" value `[ { "op": "remove", "path": "/common_settings/batch_apply_memory_limit" } ]` Enable "Limit the number of changes applied per change processing statement to" `[ { "op": "add", "path": "/common_settings/batch_split_size", "value": 1000 } ]` Disable the "Limit the number of changes applied per change processing statement to" `[ { "op": "remove", "path": "/common_settings/batch_split_size" } ]`

Change the "Apply batched changes in intervals: Longer than (seconds)" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_timeout_min", "value": 24 }
]

Return to the default "Apply batched changes in intervals: Longer than (seconds)" value

[
	{ "op": "remove", "path": "/common_settings/batch_apply_timeout_min" }
]

Change the "Apply batched changes in intervals: But less than (seconds)" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_timeout", "value": 24 }
]

Return to the default "Longer than (seconds)" and "But less than (seconds)" values

[
	{ "op": "remove", "path": "/common_settings/batch_apply_timeout" }
]

Override the default "Force apply a batch when processing memory exceeds (MB)" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_memory_limit", "value": 24 }
]

Return to the default "Force apply a batch when processing memory exceeds (MB)" value

[
	{ "op": "remove", "path": "/common_settings/batch_apply_memory_limit" }
]

Enable "Limit the number of changes applied per change processing statement to"

[
	{ "op": "add", "path": "/common_settings/batch_split_size", "value": 1000 }
]

Disable the "Limit the number of changes applied per change processing statement to"

[
	{ "op": "remove", "path": "/common_settings/batch_split_size" }
]

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

UI equivalent Body with examples

Batch Tuning

UI equivalent	Body with examples
Batch Tuning	Change "Minimum number of changes per transaction" value `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "add", "path": "/target_settings/min_transaction_size", "value": 1500 } ]` Return to default "Minimum number of changes per transaction" value" `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "remove", "path": "/target_settings/min_transaction_size" } ]` Change "Maximum time to batch transactions before applying (seconds)" value `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "remove", "path": "/target_settings/commit_timeout", "value": 500 } ]` Return to default "Minimum number of changes per transaction" value" `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "remove", "path": "/target_settings/commit_timeout" } ]`
Transaction Offload Tuning	Change "Total transactions memory size exceeds (MB)" value: `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "add", "path": "/sorter_settings/local_transactions_storage/memory_limit_total", "value": 1500 } ]` Return to default "Total transactions memory size exceeds (MB):" value: `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "remove", "path": "/sorter_settings/local_transactions_storage/memory_limit_total" } ]` Change "Transactions duration exceeds (seconds)" value `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "add", "path": "/sorter_settings/local_transactions_storage/memory_keep_time", "value": 80 } ]` Return to default "Transactions duration exceeds (seconds)" `[ { "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false }, { "op": "remove", "path": "/sorter_settings/local_transactions_storage/memory_keep_time" } ]`

Change "Minimum number of changes per transaction" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "add", "path": "/target_settings/min_transaction_size", "value": 1500 }
]

Return to default "Minimum number of changes per transaction" value"

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "remove", "path": "/target_settings/min_transaction_size" }
]

Change "Maximum time to batch transactions before applying (seconds)" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "remove", "path": "/target_settings/commit_timeout", "value": 500 }
]

Return to default "Minimum number of changes per transaction" value"

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "remove", "path": "/target_settings/commit_timeout" }
]

Transaction Offload Tuning

Change "Total transactions memory size exceeds (MB)" value:

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "add", "path": "/sorter_settings/local_transactions_storage/memory_limit_total", "value": 1500 }
]

Return to default "Total transactions memory size exceeds (MB):" value:

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "remove", "path": "/sorter_settings/local_transactions_storage/memory_limit_total" }
]

Change "Transactions duration exceeds (seconds)" value

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "add", "path": "/sorter_settings/local_transactions_storage/memory_keep_time", "value": 80 }
]

Return to default "Transactions duration exceeds (seconds)"

[
	{ "op": "add", "path": "/common_settings/batch_apply_enabled", "value": false },
	{ "op": "remove", "path": "/sorter_settings/local_transactions_storage/memory_keep_time" }
]

HTTP method: PUT

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/loggers

Action	Body with examples
Changing the global logging level	Change the global logging level to TRACE: `{ "loggers":[ { "logger_type": "AT_GLOBAL", "log_level": "DEBUG" } ] }` Change the global logging level to VERBOSE: `{ "loggers":[ { "logger_type": "AT_GLOBAL", "log_level": "DETAILED_DEBUG" } ] }` Change the global logging level to WARNING: `{ "loggers":[ { "logger_type": "AT_GLOBAL", "log_level": "WARNING" } ] }` Change the global logging level to ERROR: `{ "loggers":[ { "logger_type": "AT_GLOBAL", "log_level": "ERROR" } ] }`
Change the logging level of a specific component	Change "UTILITIES" to Trace level: `{ "loggers":[ { "logger_type": "UTILITIES", "log_level": "DETAILED_DEBUG" } ] }`
Change the global logging level and the logging level of a specific component	Change the global logging level to TRACE and the logging level of a specific component to ERROR: `{ "loggers": [ { "logger_type": "AT_GLOBAL", "log_level": "DETAILED_DEBUG" }, { "logger_type": "STREAM", "log_level": "ERROR" } ] }`
Change multiple components to different logging levels	Change "ADDONS" to VERBOSE and "STREAM" to ERROR `{ "loggers": [ { "logger_type": "ADDONS", "log_level": "DETAILED_DEBUG" }, { "logger_type": "STREAM", "log_level": "ERROR" } ] }`
Store trace/verbose logging in memory, but if an error occurs write to the logs	Enable "Store trace/verbose logging in memory, but if an error occurs write to the logs" `{ "trace_on_error":true }` Disable "Store trace/verbose logging in memory, but if an error occurs write to the logs" `{ "trace_on_error":false }` Change the "Allocate memory up to (MB)" value: `{ "trace_on_error":true, "trace_on_error_size_mb":20 }`

HTTP method: PUT

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/error_behaviors

Action	Body with examples
Environmental Errors	Change the "Maximum retry count" value: `{ "error_behavior": { "recoverable_error_behavior": { "count": 2 } } }` Restore the default "Maximum retry count" `{ "error_behavior": { "recoverable_error_behavior": { "count": -1 } } }` Disable the "Maximum retry count" option `{ "error_behavior": { "recoverable_error_behavior": { "count": 0 } } }` Enable the "Increase retry interval for long outages" option `{ "error_behavior": { "recoverable_error_behavior": { "throttling": true } } }` Disable the "Increase retry interval for long outages" option `{ "error_behavior": { "recoverable_error_behavior": { "throttling": false } } }` Change the "Maximum retry interval (seconds)" value `{ "error_behavior": { "recoverable_error_behavior": { "throttling_max": 2000 } } }`
Data Errors: For data truncation errors	Set "For data truncation errors: Ignore record" `{ "error_behavior": { "data_error_behavior": { "truncation_policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "For data truncation errors: Suspend table" `{ "error_behavior": { "data_error_behavior": { "truncation_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "For data truncation errors: Stop Task" `{ "error_behavior": { "data_error_behavior": { "truncation_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "For data truncation errors: Log record to the exceptions table" `{ "error_behavior": { "data_error_behavior": { "truncation_policy": "ERROR_POLICY_LOG_ERROR" } } }`
Data Errors: For NOT NULL constraint violations:	Enable "Check" option for "For NOT NULL constraint violations" `{ "error_behavior": { "data_error_behavior": { "nullability_check_data_error": "YES" } } }` Enable "Don't check" option for "For NOT NULL constraint violations" `{ "error_behavior": { "data_error_behavior": { "nullability_check_data_error": "NO" } } }` Enable "Endpoint-determined (Check)" option for "For NOT NULL constraint violations" `{ "error_behavior": { "data_error_behavior": { "nullability_check_data_error": "ENDPOINT_DETERMINED" } } }` Set "For NOT NULL constraint violations: Ignore record" `{ "error_behavior": { "data_error_behavior": { "nullability_policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "For NOT NULL constraint violations: Suspend table" `{ "error_behavior": { "data_error_behavior": { "nullability_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "For NOT NULL constraint violations: Stop Task" `{ "error_behavior": { "data_error_behavior": { "nullability_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "For NOT NULL constraint violations: Log record to the exceptions table" `{ "error_behavior": { "data_error_behavior": { "nullability_policy": "ERROR_POLICY_LOG_ERROR" } } }`
Data Errors: For other data errors	Set "For data truncation errors: Ignore record" `{ "error_behavior": { "data_error_behavior": { "policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "For data truncation errors: Suspend table" `{ "error_behavior": { "data_error_behavior": { "policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "For data truncation errors: Stop Task" `{ "error_behavior": { "data_error_behavior": { "policy": "ERROR_POLICY_STOP_TASK" } } }` Set "For data truncation errors: Log record to the exceptions table" `{ "error_behavior": { "data_error_behavior": { "policy": "ERROR_POLICY_LOG_ERROR" } } }` Enable "Escalate handling when data errors reach (per table)" checkbox `{ "error_behavior": { "data_error_behavior": { "escalation_count": 50 } } }` Disable "Escalate handling when data errors reach (per table)" checkbox `{ "error_behavior": { "data_error_behavior": { "escalation_count": 0 } } }` Set "Escalation action: Stop Task" for data errors `{ "error_behavior": { "data_error_behavior": { "escalation_count": 50, "escalation_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "Escalation action: Suspend table" for data errors `{ "error_behavior": { "data_error_behavior": { "escalation_count": 50, "escalation_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }`
Table Errors	Set "When encountering a table error: Stop Task" `{ "error_behavior": { "table_error_behavior": { "policy": "ERROR_POLICY_STOP_TASK" } } }` Set "When encountering a table error: Suspend table" `{ "error_behavior": { "table_error_behavior": { "policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Enable "Escalate handling when data errors reach (per table)" checkbox `{ "error_behavior": { "table_error_behavior": { "escalation_count": 50 } } }` Disable "Escalate handling when data errors reach (per table)"checkbox `{ "error_behavior": { "table_error_behavior": { "escalation_count": 0 } } }`
Apply Conflict: No record found for applying DELETE	Set "No record found for applying DELETE: Ignore record" `{ "error_behavior": { "apply_error_behavior": { "delete_policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "No record found for applying DELETE: Suspend table" `{ "error_behavior": { "apply_error_behavior": { "delete_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "No record found for applying DELETE: Stop Task" `{ "error_behavior": { "apply_error_behavior": { "delete_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "No record found for applying DELETE: Log record to the exceptions table" `{ "error_behavior": { "apply_error_behavior": { "delete_policy": "ERROR_POLICY_LOG_ERROR" } } }`
Apply Conflict: Duplicate key when applying INSERT	Set "Duplicate key when applying INSERT:Ignore record" of Apply Conflict `{ "error_behavior": { "apply_error_behavior": { "insert_policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "Duplicate key when applying INSERT: Suspend table" `{ "error_behavior": { "apply_error_behavior": { "insert_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "Duplicate key when applying INSERT: Stop Task" `{ "error_behavior": { "apply_error_behavior": { "insert_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "Duplicate key when applying INSERT: Log record to the exceptions table" `{ "error_behavior": { "apply_error_behavior": { "insert_policy": "ERROR_POLICY_LOG_ERROR" } } }` Set "Duplicate key when applying INSERT: UPDATE the existing target record" `{ "error_behavior": { "apply_error_behavior": { "insert_policy": "ERROR_POLICY_MERGE_MODE" } } }`
Apply Conflict: No record found for applying an UPDATE	Set "No record found for applying an UPDATE: Ignore record" `{ "error_behavior": { "apply_error_behavior": { "update_policy": "ERROR_POLICY_IGNORE_RECORD" } } }` Set "No record found for applying an UPDATE: Suspend table" `{ "error_behavior": { "apply_error_behavior": { "update_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "No record found for applying an UPDATE: Stop Task" `{ "error_behavior": { "apply_error_behavior": { "update_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "No record found for applying an UPDATE: Log record to the exceptions table" `{ "error_behavior": { "apply_error_behavior": { "update_policy": "ERROR_POLICY_LOG_ERROR" } } }` Set "No record found for applying an UPDATE: INSERT the missing target record" `{ "error_behavior": { "apply_error_behavior": { "update_policy": "ERROR_POLICY_UPSERT_MODE" } } }`
Apply Conflict: Escalate handling when data errors reach (per table)	Enable "Escalate handling when data errors reach (per table)" checkbox `{ "error_behavior": { "apply_error_behavior": { "escalation_count": 50 } } }` Disable "Escalate handling when data errors reach (per table)" checkbox `{ "error_behavior": { "apply_error_behavior": { "escalation_count": 0 } } }` Set "Escalation action: Stop Task" `{ "error_behavior": { "apply_error_behavior": { "escalation_count": 50, "escalation_policy": "ERROR_POLICY_STOP_TASK" } } }` Set "Escalation action: Suspend table" `{ "error_behavior": { "apply_error_behavior": { "escalation_count": 50, "escalation_policy": "ERROR_POLICY_SUSPEND_TABLE" } } }` Set "Escalation action: Log record to the exceptions table" `{ "error_behavior": { "apply_error_behavior": { "escalation_count": 50, "escalation_policy": "ERROR_POLICY_LOG_ERROR" } } }`

HTTP method: PUT

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/properties

Action	Body with examples
Add Valid Description	Add Description (Uppercase/Lowercase/Numbers/Space/Special Characters) `{ "description": "important task" }`
Remove Description	Remove Description `{ "description": "" }`

HTTP method: PATCH

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings

Action	Body with examples
Add new Feature Flag	Add new feature flag: `[ { "op": "add", "path": "/common_settings/feature_flags/<flag-name>", "value": "<value>" } ]`
Remove Feature Flag	Remove existing Feature Flag `[ { "op": "remove", "path": "/common_settings/feature_flags/<flag-name>" } ]`

Getting settings

You can get the current settings using the Patch Template API or the Get API, depending on which settings you need to get.

Use the Patch Template API to get current values for all settings, except Replicate loggers, the task description, and error handling settings.
Use the Get API to get current settings for Replicate loggers, the task description, and error handling.

Use this to get current values for all settings, except Replicate loggers, the task description, and error handling settings. For those settings, use the Get API described below.

HTTP method: PUT

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/settings?action=patch_template

Action	Body with examples
Get the current settings	Find out if LOB support is enabled, the maximum LOB size, and the target schema: `[ { "path": "/common_settings/support_lobs" }, { "path": "/target_settings/default_schema" }, { "path": "/common_settings/lob_max_size" } ]`

Use this to get current settings for Replicate loggers, the task description, and error handling.

HTTP method: GET

URL: attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/<settings-type>

Get the error handling settings:

To get all error handling settings and their values, call:

attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/error_behaviors

Get the task description:

To get the task description, call:

attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/properties

Get the logger settings:

To get the logger settings, call:

attunityenterprisemanager/api/v1/servers/<my-replicate-server>/tasks/<my-replicate-task-name>/loggers

Errors

Apart from specific errors related to settings that are not valid, you might also encounter general errors. For more information on these, see general errors.

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 – please let us know!

Leave your feedback here