Qlik Sense APIs · Schema

Replication Task Configuration (Replication)

Schema for Replication task configuration

AgentsAnalyticsArtificial IntelligenceBusiness IntelligenceCloudData IntegrationData VisualizationEmbedded AnalyticsEnterpriseMachine-Learning

Properties

Name Type Description
fullLoadOnly object
targetEndpoint object Target endpoint configuration
dataProviderType object
replicationAppRuntime object Replication runtime settings
proxySettings object
taskSettings object Task-specific settings
fullLoadOptions object Full load options
applyChangesOptions object Apply changes options
storeChangesOptions object Options for storing changes
errorHandling object Error handling configuration
metadata object Metadata configuration
changeProcessingTuning object Batch and transaction tuning options
characterSubstitution object
moreOptions object
fileAttributes object File attributes
catalogSettings object Catalog settings
ddlHandlingPolicy object
View JSON Schema on GitHub

JSON Schema

qliksense-qtcp-task.settings.replication.schema.json Raw ↑
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://raw.githubusercontent.com/qlik-oss/schemas/refs/heads/main/qtcp/task.settings.replication.schema.json",
	"title": "Replication Task Configuration (Replication)",
	"description": "Schema for Replication task configuration",
	"type": "object",
	"additionalProperties": false,
	"required": ["taskSettings", "targetEndpoint"],
	"properties": {
		"fullLoadOnly": {
			"$ref": "task.settings.common.schema.json#/definitions/fullLoadOnly-False"
		},
		"targetEndpoint": {
			"type": "object",
			"description": "Target endpoint configuration",
			"properties": {
				"targetConnection": {
					"type": "string",
					"description": "Target connection ID"
				},
				"targetSchema": {
					"type": "string",
					"description": "Target schema name"
				},
				"targetStorageConnection": {
					"type": "string",
					"description": "Target storage connection ID"
				},
				"targetControlTableSchema": {
					"type": "string",
					"description": "Target control table schema name"
				}
			},
			"required": [
				"targetConnection",
				"targetSchema",
				"targetStorageConnection"
			],
			"additionalProperties": false
		},
		"dataProviderType": {
			"$ref": "task.settings.common.schema.json#/definitions/dataProviderType"
		},
		"replicationAppRuntime": {
			"type": "object",
			"description": "Replication runtime settings",
			"properties": {
				"sourceCdcFetchIntervalMinutes": {
					"type": "integer",
					"description": "Source CDC fetch interval in minutes",
					"default": 60
				},
				"cdcSettings": {
					"$ref": "task.settings.common.schema.json#/definitions/cdcSettings"
									
				},
				"initialLoadMode": {
					"$ref": "task.settings.common.schema.json#/definitions/initialLoadMode"
				}
			},
			"additionalProperties": false
		},
		"proxySettings": {
			"$ref": "task.settings.common.schema.json#/definitions/proxySettings"
		},
		"taskSettings": {
			"type": "object",
			"description": "Task-specific settings",
			"properties": {
				"fullLoad": {
					"type": "boolean",
					"description": "Enable full load",
					"enum": [true, false],
					"default": false
				},
				"applyChanges": {
					"type": "boolean",
					"description": "Apply changes after full load",
					"enum": [true, false],
					"default": false
				},
				"storeChanges": {
					"type": "boolean",
					"description": "Store changes after full load",
					"enum": [true, false],
					"default": false
				}
			},
			"anyOf": [
				{
					"required": ["fullLoad"],
					"properties": {
						"fullLoad": {
							"const": true
						}
					}
				},
				{
					"required": ["applyChanges"],
					"properties": {
						"applyChanges": {
							"const": true
						}
					}
				},
				{
					"required": ["storeChanges"],
					"properties": {
						"storeChanges": {
							"const": true
						}
					}
				}
			],
			"additionalProperties": false
		},
		"fullLoadOptions": {
			"type": "object",
			"description": "Full load options",
			"properties": {
				"tableExistsHandling": {
					"$ref": "task.settings.common.schema.json#/definitions/tableExistsHandling"
				},
				"afterFullLoadCompleted": {
					"type": "object",
					"description": "Actions after full load is completed",
					"properties": {
						"stopTask": {
							"type": "object",
							"description": "Stop task options",
							"properties": {
								"beforeCachedChanges": {
									"type": "boolean",
									"enum": [true, false],
									"default": false
								},
								"afterCachedChanges": {
									"type": "boolean",
									"enum": [true, false],
									"default": false
								}
							},
							"additionalProperties": false
						},
						"createKeyOrUniqueIndex": {
							"$ref": "task.settings.common.schema.json#/definitions/createKeyOrUniqueIndex"
						}
					},
					"additionalProperties": false
				},
				"fullLoadOptionsTuning": {
					"$ref": "task.settings.common.schema.json#/definitions/fullLoadOptionsTuning"
				}
			},
			"additionalProperties": false
		},
		"applyChangesOptions": {
			"type": "object",
			"description": "Apply changes options",
			"properties": {
				"sourceTableDropped": {
					"type": "boolean",
					"description": "Indicates if the source table was dropped",
					"enum": [true, false],
					"default": false
				},
				"sourceTableTruncated": {
					"type": "boolean",
					"description": "Indicates if the source table was truncated",
					"enum": [true, false],
					"default": false
				},
				"sourceTableAltered": {
					"type": "boolean",
					"description": "Indicates if the source table was altered",
					"enum": [true, false],
					"default": false
				},
				"changeProcessingTuning": {
					"$ref": "task.settings.common.schema.json#/definitions/applyChangesOptionsChangeProcessingTuning"
				}
			},
			"additionalProperties": false
		},
		"storeChangesOptions": {
			"type": "object",
			"description": "Options for storing changes",
			"properties": {
				"ddlOptions": {
					"type": "boolean",
					"description": "Enable DDL options for storing changes",
					"enum": [true, false],
					"default": false
				},
				"onUpdate": {
					"type": "boolean",
					"description": "Enable update handling for storing changes",
					"enum": [true, false],
					"default": false
				},
				"changeTableCreation": {
					"type": "string",
					"description": "Change table creation policy",
					"enum": ["DROP_AND_CREATE", "TRUNCATE", "IGNORE"],
					"default": "DROP_AND_CREATE"
				},
				"suffix": {
					"type": "string",
					"description": "Suffix for change tables",
					"examples": ["__ct"]
				},
				"headerColumnPrefix": {
					"type": "string",
					"description": "Prefix for header columns",
					"examples": ["header__"]
				},
				"changeDataPartitioning": {
					"type": "object",
					"description": "Change data partitioning settings",
					"properties": {
						"mode": {
							"type": "string",
							"description": "Partitioning mode",
							"enum": ["PARTITION_OFF"],
							"default": "PARTITION_OFF"
						},
						"partitionEvery": {
							"type": "integer",
							"description": "Partition every N units",
							"default": 60
						}
					},
					"additionalProperties": false
				},
				"changeTableHeaderColumn": {
					"$ref": "task.settings.common.schema.json#/definitions/changeTableHeaderColumn"
				}
			},
			"additionalProperties": false
		},
		"errorHandling": {
			"type": "object",
			"description": "Error handling configuration",
			"properties": {
				"applyConflicts": {
					"$ref": "task.settings.common.schema.json#/definitions/errorHandlingApplyConflicts"
				},
				"data": {
					"$ref": "task.settings.common.schema.json#/definitions/errorHandlingData"
				},
				"tableError": {
					"$ref": "task.settings.common.schema.json#/definitions/errorHandlingTableError"
				},
				"environmental": {
					"$ref": "task.settings.common.schema.json#/definitions/errorHandlingEnvironmental"
				}
			},
			"additionalProperties": false
		},
		"metadata": {
			"type": "object",
			"description": "Metadata configuration",
			"properties": {
				"lobHandling": {
					"$ref": "task.settings.common.schema.json#/definitions/lobHandling"
				},
				"targetControlTableTablespace": {
					"type": "string",
					"description": "Target tablespace for control tables"
				},
				"targetControlTableIndexesTablespace": {
					"type": "string",
					"description": "Target tablespace for control table indexes"
				},
				"historyTimeSlot": {
					"type": "integer",
					"description": "Time slot for history retention",
					"default": 5
				},
				"targetControlTableSchema": {
					"type": "string",
					"description": "Target schema for control tables"
				},
				"controlTableSelection": {
					"$ref": "task.settings.common.schema.json#/definitions/controlTableSelection"
				},
				"jsonHandling": {
					"$ref": "task.settings.common.schema.json#/definitions/jsonHandling"
				}
			},
			"additionalProperties": false
		},
		"changeProcessingTuning": {
			"type": "object",
			"description": "Batch and transaction tuning options",
			"properties": {
				"batchApply": {
					"$ref": "task.settings.common.schema.json#/definitions/batchApply"
				},
				"batchSplitSize": {
					"$ref": "task.settings.common.schema.json#/definitions/batchSplitSize"
				},
				"transactionTuning": {
					"$ref": "task.settings.common.schema.json#/definitions/transactionTuning-TotalMemoryFalse"
				},
				"transactionalApply": {
					"$ref": "task.settings.common.schema.json#/definitions/transactionalApply"
				}
			},
			"additionalProperties": false
		},
		"characterSubstitution": {
			"$ref": "task.settings.common.schema.json#/definitions/characterSubstitution"
		},
		"moreOptions": {
			"$ref": "task.settings.common.schema.json#/definitions/moreOptions"
		},
		"fileAttributes": {
			"type": "object",
			"description": "File attributes",
			"additionalProperties": false,
			"properties": {
				"general": {
					"$ref": "task.settings.common.schema.json#/definitions/fileAttributesGeneral-Replication"
				}
			}
		},
		"catalogSettings": {
			"type": "object",
			"description": "Catalog settings",
			"properties": {
				"publish": {
					"type": "boolean",
					"description": "Whether to publish datasets to catalog",
					"enum": [true, false],
					"default": false
				},
				"tags": {
					"type": "array",
					"description": "Tags for catalog settings",
					"items": {
						"type": "string",
						"description": "Tag value for catalog"
					}
				}
			},
			"additionalProperties": false
		},
		"ddlHandlingPolicy": {
			"$ref": "task.settings.common.schema.json#/definitions/ddlHandlingPolicy"
		}
	}
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qliksense-qtcp-task.settings.replication.schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.