Qlik Sense APIs · Schema

Task transformation Configuration

Schema for task transformation configuration

AgentsAnalyticsArtificial IntelligenceBusiness IntelligenceCloudData IntegrationData VisualizationEmbedded AnalyticsEnterpriseMachine-Learning

Properties

Name Type Description
modifiedByAi object
rules array Transformation rules array
View JSON Schema on GitHub

JSON Schema

qliksense-qtcp-task.transformationrules.schema.json Raw ↑
{
	"$schema": "http://json-schema.org/draft-07/schema#",
	"$id": "https://raw.githubusercontent.com/qlik-oss/schemas/refs/heads/main/qtcp/task.transformationrules.schema.json",
	"title": "Task transformation Configuration",
	"description": "Schema for task transformation configuration",
	"type": "object",
	"required": ["rules"],
	"additionalProperties": false,
	"properties": {
		"modifiedByAi": { "$ref": "#/$defs/ModifiedByAi" },
		"rules": {
			"type": "array",
			"description": "Transformation rules array",
			"items": {
				"type": "object",
				"description": "Local transformations to be applied to the task",
        		"properties": {
					"ordinal": {
						"type": "integer",
						"description": "Execution order of the rule",
						"default": 0
					},
					"enabled": {
						"type": "boolean",
						"description": "Indicates whether the rule is active and should be applied",
						"enum": [true, false],
						"default": true
					},
					"internalRule": {
						"type": "boolean",
						"description": "Indicates if the rule is system-internal (not user created)",
						"enum": [true, false],
						"default": false
					},
					"name": {
						"type": "string",
						"description": "Rule display name",
						"example": "Rule_1"
					},
					"id": {
						"type": "string",
						"description": "Rule internal ID",
						"example": "rule-hogc"
					},
					"description": {
						"type": "string",
						"description": "Rule description"
					},
					"actionType": {
						"type": "string",
						"description": "The type of transformation action to perform",
						"enum": ["RENAME_TABLE", "RENAME_COLUMN", "ADD_COLUMN", "DROP_COLUMN", "REPLACE_COLUMN_VALUE", "CHANGE_COLUMN_DATA_TYPE"]
					},
					"scopeType": {
						"type": "string",
						"description": "The scope type",
						"enum": ["NONE", "TABLE", "COLUMN"]
					},
					"scope": {
						"type": "object",
						"description": "Criteria for defining the objects to which the rule applies",
						"additionalProperties": false,
						"required": [],
						"properties": {
							"whereOwnerName": {
								"type": "string",
								"description": "Schema name pattern (may include wildcards)",
								"example": "%a"
							},
							"whereTableName": {
								"type": "string",
								"description": "Table name pattern (may include wildcards)",
								"example": "%b"
							},
							"whereColumnName": {
								"type": "string",
								"description": "Column name pattern (may include wildcards)",
								"example": "%c"
							},
							"whereDatatype": {
								"type": "string",
								"description": "Column datatype attribute filter",
								"enum": ["UNSPECIFIED", "BOOLEAN", "BYTES", "DATE", "TIME", "DATETIME", "INT1", "INT2", "INT4", "INT8", "REAL4", "REAL8", "UINT1", "UINT2", "UINT4", "UINT8", "NUMERIC", "STRING", "WSTRING", "BLOB", "CLOB", "NCLOB", "JSON"],
								"default": "UNSPECIFIED"
							},
							"whereColumnKeyAttribute": {
								"type": "string",
								"description": "Column key attribute filter",
								"enum": ["ANY", "PK_ONLY", "NOT_PK_ONLY"],
								"default": "ANY"
							},
							"whereColumnNullability": {
								"type": "string",
								"description": "Column nullability filter",
								"enum": ["ANY", "NULLABLE_ONLY", "NOT_NULLABLE_ONLY"],
								"default": "ANY"
							}
						}
					},
					"action": {
						"type": "object",
						"description": "Transformation action to apply",
						"required": [],
						"additionalProperties": false,
						"properties": {
							"renameType": {
								"type": "string",
								"description": "Type of rename operation",
								"enum": ["NONE", "RENAME", "ADD_PREFIX", "REMOVE_PREFIX", "ADD_SUFFIX", "REMOVE_SUFFIX", "REPLACE_PREFIX", "REPLACE_SUFFIX", "TO_UPPER", "TO_LOWER", "EXPRESSION", "NAME_MAPPING"]
							},
							"value": {
								"$ref": "#/$defs/Value"
							},
							"oldValue": {
								"type": "string",
								"description": "Value to replace (used by REPLACE_PREFIX / REPLACE_SUFFIX)"
							},
							"expression": {
								"$ref": "#/$defs/Expression"
							},
							"valueMapping": {
								"type": "object",
								"description": "Dynamic key-value mapping where keys are variable property names (used by NAME_MAPPING)",
								"additionalProperties": {
									"type": "string",
									"description": "Mapped value for the key"
								},
								"examples": [
									{"key1": "value1", "key2": "value2"}
								]
							},
							"applyColumnDatatype": {
								"type": "boolean",
								"description": "Indicates whether to apply the provided datatype to the column after action",
								"enum": [true, false],
								"default": false
							},
							"column": {
								"type": "object",
								"description": "Column definition used when applying datatype changes",
								"additionalProperties": false,
								"required": [],
								"properties": {
									"name": {
										"type": "string",
										"description": "The column name"
									},
									"ordinal": {
										"type": "integer",
										"description": "The ordinal position of the column",
										"default": 0
									},
									"nullable": {
										"type": "boolean",
										"description": "Whether the column allows null values",
										"enum": [true, false],
										"default": true
									},
									"primaryKeyOrdinal": {
										"type": "integer",
										"description": "The ordinal position in the primary key",
										"default": 0
									},
									"datatype": {
										"type": "object",
										"description": "The new data type definition for the column",
										"additionalProperties": false,
										"required": ["type"],
										"properties": {
											"type": {
												"type": "string",
												"description": "The data type of the column",
												"enum": ["UNSPECIFIED", "BOOLEAN", "BYTES", "DATE", "TIME", "DATETIME", "INT1", "INT2", "INT4", "INT8", "REAL4", "REAL8", "UINT1", "UINT2", "UINT4", "UINT8", "NUMERIC", "STRING", "WSTRING", "BLOB", "CLOB", "NCLOB", "JSON"],
												"default": "UNSPECIFIED"
											},
											"length": {
												"type": "integer",
												"description": "The length of the data type",

												"default": 0
											},
											"precision": {
												"type": "integer",
												"description": "The precision of the data type",
												"default": 0
											},
											"scale": {
												"type": "integer",
												"description": "The scale of the data type",
												"default": 0
											},
											"originalTypeFull": {
												"type": "string",
												"description": "The original full type description"
											}
										}
									},
									"flags": {
										"type": "string",
										"description": "Miscellaneous flags",
										"enum": ["NONE"],
										"default": "NONE"
									}
								}
							}
						}
					}
				},
				"required": ["name","actionType"],
				"allOf": [
					{
						"if": {
							"anyOf": [
								{
									"properties": { 
										"actionType": { 
											"const": "RENAME_TABLE" 
										} 
									}, 
									"required": ["name","actionType"] 
								},
								{
									"properties": { 
										"actionType": { 
											"const": "RENAME_COLUMN" 
										} 
									}, 
									"required": ["name","actionType"] 
								}
							]
						},
						"then": {
							"properties": {
								"ordinal":true,
								"enabled": true,
								"internalRule": true,
								"name":true,
								"id": true,
								"description": true,
								"actionType":true,
								"scopeType": true,
								"scope": true,
								"action": {
									"type": "object",
									"properties": {
										"renameType": {
											"type": "string",
											"description": "Type of rename operation",
											"enum": ["NONE", "RENAME", "ADD_PREFIX", "REMOVE_PREFIX", "ADD_SUFFIX", "REMOVE_SUFFIX", "REPLACE_PREFIX", "REPLACE_SUFFIX", "TO_UPPER", "TO_LOWER", "EXPRESSION", "NAME_MAPPING"]
										},
										"value": {"$ref": "#/$defs/Value"},
										"applyColumnDatatype": true,
										"column": true
									},
									"allOf": [
										{
											"if": {
												"properties": {
													"renameType": { "const": "EXPRESSION" }
												},
												"required": ["renameType"]
											},
											"then": {
												"properties": {
													"renameType":true,
													"value": {"$ref": "#/$defs/Value"},
													"applyColumnDatatype": true,
													"column": true,
													"expression": {"$ref": "#/$defs/Expression"}
												},
												"additionalProperties": false
											}
										},
										{
											"if": {
												"properties": {
													"renameType": { "const": "NAME_MAPPING" }
												},
												"required": ["renameType"]
											},
											"then": {
												"properties": {
													"renameType":true,
													"value": {"$ref": "#/$defs/Value"},
													"applyColumnDatatype": true,
													"column": true,
													"valueMapping": {
														"type": "object",
														"description": "Dynamic key-value mapping where keys are variable property names",
														"additionalProperties": {
															"type": "string",
															"description": "Mapped value for the key"
														},
														"examples": [
															{"key1": "value1", "key2": "value2"}
														]
													}
												},
												"additionalProperties": false
											}
										},
										{
											"if": {
												"properties": {
													"renameType": { "const": "REPLACE_PREFIX" }
												},
												"required": ["renameType"]
											},
											"then": {
												"properties": {
													"renameType": true,
													"value": {"$ref": "#/$defs/Value"},
													"oldValue": {
														"type": "string",
														"description": "Value to replace"
													},
													"applyColumnDatatype": true,
													"column": true
												},
												"additionalProperties": false
											}
										}
									]
								}
							},
							"additionalProperties": false
						}
					},
					{
						"if": {
							"properties": { 
								"actionType": { 
									"const": "REPLACE_COLUMN_VALUE" 
								} 
							}, 
							"required": ["name","actionType"] 
						},
						"then": {
							"properties": {
								"action": {
									"properties": {
										"renameType":true,
										"applyColumnDatatype": true,
										"column": true,
										"expression": {"$ref": "#/$defs/Expression"}
									},
									"additionalProperties": false
								}
							}
						}
					},
					{
						"if": {
							"properties": { 
								"actionType": { 
									"const": "ADD_COLUMN" 
								} 
							}, 
							"required": ["name","actionType"] 
						},
						"then": {
							"properties": {
								"action": {
									"properties": {
										"renameType":true,
										"expression": {"$ref": "#/$defs/Expression"},
										"applyColumnDatatype": true,
										"column": {
											"properties": {
												"name": {
													"type": "string",
													"description": "The column name",
													"example": ["newcol"]
												},
												"ordinal":true,
												"nullable": true,
												"primaryKeyOrdinal": true,
												"datatype": true,
												"flags": true
											},
											"additionalProperties": false
										}
									},
									"additionalProperties": false
								}
							}
						}
					},
					{
						"if": {
							"oneOf": [
								{ 
									"properties": { 
										"actionType": { 
											"const": "DROP_COLUMN" 
										} 
									}, 
									"required": ["name","actionType"] 
								},
								{ 
									"properties": { 
										"actionType": { 
											"const": "CHANGE_COLUMN_DATA_TYPE" 
										} 
									}, 
									"required": ["name","actionType"] 
								}
							]
						},
						"then": {
							"properties": {
								"action": {
									"properties": {
										"renameType":true,
										"applyColumnDatatype": true,
										"column": true
									},
									"additionalProperties": false
								}
							}
						}
					}
				]
			}
		}
	},
	"$defs": {
		"ModifiedByAi": {
			"type": "object",
			"description": "Metadata describing the latest AI modification",
			"required": ["lastUpdated", "model"],
			"properties": {
				"lastUpdated": { "type": "string", "format": "date-time", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$", "description": "UTC timestamp of the latest AI modification" },
				"model": { "type": "string", "minLength": 1, "description": "AI model that made the latest modification" }
			},
			"additionalProperties": false
		},
		"Value": {
			"type": "string",
			"description": "Value for the rename / new value for replace"
		},
		"Expression": { 
			"type": "object",
			"description": "The expression used for the column value",
			"properties": {
				"expressionStatement": {
					"type": "string",
					"description": "The SQL-like expression statement"
				},
				"alias": {
					"type": "array",
					"description": "An array of mapping aliases for the expression",
					"items": {
						"type": "object",
						"description": "Mapping alias",
						"properties": {
							"name": {
								"type": "string",
								"description": "Parameter name to replace"
							},
							"value": {
								"type": "string",
								"description": "New value"
							}
						},
						"additionalProperties": false
					}
				}
			},
			"required": ["expressionStatement"],
			"additionalProperties": false
		}
	}
}

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.transformationrules.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.