{ "info": { "title": "data-governance/semantic-types", "version": "" }, "paths": { "/api/data-governance/semantic-types": { "get": { "tags": [ "semantic-types" ], "summary": "List semantic types", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticTypeListResponse" } } }, "headers": { "ETag": { "$ref": "#/components/headers/ETagHeader" } }, "description": "List of semantic type definitions" }, "304": { "headers": { "ETag": { "$ref": "#/components/headers/ETagHeader" } }, "description": "The semantic type list has not changed since the ETag provided in the `If-None-Match` request header." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request contains invalid fields." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "$ref": "#/components/parameters/IfNoneMatchHeader" }, { "$ref": "#/components/parameters/FieldsFilterQuery" }, { "$ref": "#/components/parameters/IdsListQuery" }, { "$ref": "#/components/parameters/ParentIdsListQuery" } ], "description": "Retrieves all semantic types for a tenant. Supports conditional requests via the `If-None-Match` header.\n", "operationId": "listSemanticTypes", "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "post": { "tags": [ "semantic-types" ], "summary": "Create a semantic type", "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticTypeResponse" } } }, "description": "Semantic type created successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format, or the semantic type failed validation (for example, a duplicate `label`, an invalid `validationPattern`, or missing dictionary `values`)." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The payload Too Large." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "description": "Creates a new semantic type for the current tenant. A semantic type can be defined as a regular expression, a dictionary of values, or a compound of other semantic types, as specified by the `type` field in the request body.\n", "operationId": "createSemanticType", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CreateSemanticTypeRegexRequest" }, { "$ref": "#/components/schemas/CreateSemanticTypeCompoundRequest" }, { "$ref": "#/components/schemas/CreateSemanticTypeDictionaryRequest" } ], "example": { "type": "REGEX", "label": "Qlik email", "description": "qlik email is a trigram followed by @qlik", "validationPattern": "^[a-z]{3}@qlik\\.com$" }, "description": "A semantic type definition, expressed as a `REGEX` pattern, a `DICTIONARY` of values, or a `COMPOUND` of other semantic types.", "discriminator": { "mapping": { "REGEX": "#/components/schemas/CreateSemanticTypeRegexRequest", "COMPOUND": "#/components/schemas/CreateSemanticTypeCompoundRequest", "DICTIONARY": "#/components/schemas/CreateSemanticTypeDictionaryRequest" }, "propertyName": "type" } } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/api/data-governance/semantic-types/{semanticTypeId}": { "get": { "tags": [ "semantic-types" ], "summary": "Get a semantic type", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticTypeResponse" } } }, "description": "Semantic type retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "$ref": "#/components/parameters/FieldsFilterQuery" }, { "$ref": "#/components/parameters/SemanticTypeIdPath" } ], "description": "Returns the definition of a single semantic type identified by its ID, including its configuration (regex, dictionary, or compound rules).\n", "operationId": "getSemanticType", "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } }, "patch": { "tags": [ "semantic-types" ], "summary": "Update a semantic type", "responses": { "204": { "description": "Semantic type updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The payload Too Large." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "$ref": "#/components/parameters/SemanticTypeIdPath" } ], "description": "Partially updates an existing semantic type identified by its ID. Only the fields included in the request payload are modified; omitted fields keep their current values.\n", "operationId": "patchSemanticType", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchSemanticTypeRequest" } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } }, "delete": { "tags": [ "semantic-types" ], "summary": "Delete a semantic type", "responses": { "204": { "description": "Semantic type deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format, or the semantic type cannot be deleted because it is used as a child of a `COMPOUND` type." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "$ref": "#/components/parameters/SemanticTypeIdPath" } ], "description": "Permanently deletes a semantic type identified by its ID. This operation cannot be undone. Any dataset fields previously associated with the semantic type will no longer be classified by it. A semantic type used as a child of a `COMPOUND` type cannot be deleted until it is removed from that `COMPOUND` type.\n", "operationId": "deleteSemanticType", "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/api/data-governance/semantic-types/{semanticTypeId}/dataset-fields": { "get": { "tags": [ "semantic-types" ], "summary": "List dataset fields affected by a semantic type", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatasetFieldsPageResponse" } } }, "description": "Dataset fields retrieved successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad request." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Resource does not exist." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "parameters": [ { "$ref": "#/components/parameters/SemanticTypeIdPath" }, { "$ref": "#/components/parameters/PageQuery" }, { "$ref": "#/components/parameters/LimitQuery" }, { "$ref": "#/components/parameters/SortQuery" } ], "description": "Returns a paginated list of datasets and their field names that are associated with the specified semantic type. Data is pre-computed from the dataset relationship collection and populated lazily when data quality events are processed.\n", "operationId": "getDatasetFields", "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "1", "limit": 1000 } } }, "/api/data-governance/semantic-types/actions/export": { "post": { "tags": [ "import-export" ], "summary": "Export semantic types", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticTypesExportEnvelope" } } }, "headers": { "Content-Disposition": { "schema": { "type": "string", "example": "attachment; filename=\"semantic-types-20260604143052.json\"" }, "description": "Suggested filename for the download. Includes timestamp in UTC (format: YYYYMMDDHHMMSS) and the type filter (lowercase) when applicable. Examples: `semantic-types-20260604143052.json`, `semantic-types-regex-20260604143052.json`.\n" } }, "description": "Export file containing the requested semantic types." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request is in incorrect format." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "description": "Exports semantic types from the current tenant as a downloadable JSON file. Supports optional filtering by type IDs, category, creator, or search term. Without filters, all types (user-created and Qlik defaults) are exported.\n", "operationId": "exportSemanticTypes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportRequest" } } }, "required": false }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } }, "/api/data-governance/semantic-types/actions/import": { "post": { "tags": [ "import-export" ], "summary": "Import semantic types", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportConflictResponse" }, "examples": { "importReport": { "value": {}, "summary": "Import report (resolved import with conflicts)" }, "conflictResponse": { "value": { "code": "IMPORT_CONFLICT", "types": [ { "type": "REGEX", "label": "Email Address", "status": "CONFLICT" } ], "message": "Conflicts: 1 of 3." }, "summary": "Conflict / preview response" } } } }, "description": "Nothing was imported. The body is an `ImportConflictResponse`:\n- when `skipConfirmation=true` but real conflicts or in-file\n duplicates exist — nothing was imported;\n\n- when `skipConfirmation` is false/absent (preview) — nothing was\n imported. Re-submit with `skipConfirmation=true` or\n `conflictResolutions` to apply.\n" }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportReport" }, "examples": { "importReportNoConflicts": { "value": { "summary": { "errored": { "count": 0 }, "skipped": { "count": 0 }, "updated": { "count": 0 }, "duplicates": { "count": 0 }, "totalCreated": { "count": 3, "items": [ { "id": "abc-1", "label": "Email Address" } ], "labels": [ "Email Address" ] } } }, "summary": "Import report (no conflicts)" }, "importReportWithConflicts": { "value": { "summary": { "errored": { "count": 0 }, "skipped": { "count": 0 }, "updated": { "count": 1, "items": [ { "id": "abc-1", "label": "Email Address" } ], "labels": [ "Email Address" ] }, "duplicates": { "count": 0 }, "totalCreated": { "count": 0 } } }, "summary": "Import report (resolved import with conflicts)" } } } }, "description": "Import applied. The report contains summary counts and a detailed error list for any types that could not be processed. Returned in both the no-conflict case and when `conflictResolutions` were provided (regardless of whether conflicts were present).\n" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid payload — malformed JSON, unknown format, or structural error." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have valid authentication credentials." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "User does not have access to the resource." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Requested service is not available." } }, "description": "Imports semantic types from a JSON file. Supports Qlik Cloud format (`QlikSemanticTypesExport`) and Talend legacy format (`DQDictionaryImportExport`). Format is auto-detected from the `exportFormat` field in the payload.\n\n**Conflict handling** is controlled by the `skipConfirmation` flag and the optional `conflictResolutions` array:\n\n- **Preview** (`skipConfirmation` false/absent, no `conflictResolutions`):\n the file is analysed but nothing is imported. Returns `200` with a\n per-type conflict/summary body. Re-submit with `skipConfirmation=true`\n or `conflictResolutions` to actually apply the import.\n\n\n- **One-shot** (`skipConfirmation=true`, no `conflictResolutions`):\n if real conflicts or in-file duplicates exist, returns `200` with the\n conflict body and imports nothing; otherwise the import is applied and\n `201` is returned with the import report.\n\n\n- **Resolved** (`conflictResolutions` provided): the import is applied using\n the per-label strategies, falling back to `defaultConflictStrategy`\n (defaults to `SKIP`) for unlisted labels. Returns `201` in both cases\n (conflicts present or not), with the import report.\n\n\nImport is best-effort: each type is processed independently. Failures are logged in the response report without blocking other types.\n", "operationId": "importSemanticTypes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } }, "required": true }, "x-qlik-stability": "stable", "x-qlik-visibility": "public", "x-qlik-deprecated": false, "x-qlik-tier": { "tier": "2", "limit": 100 } } } }, "openapi": "3.0.0", "components": { "headers": { "ETagHeader": { "schema": { "type": "string" }, "description": "ETag send in response to check if resource changed" } }, "parameters": { "FieldsFilterQuery": { "in": "query", "name": "fields", "schema": { "type": "string" }, "example": "label,type", "description": "A comma-separated list of fields to include in the response. The `id` field is always returned regardless of this filter." }, "IdsListQuery": { "in": "query", "name": "ids", "schema": { "$ref": "#/components/schemas/SemanticTypeIds" }, "example": "3b179e2b028c4306ab108b68116ae639,4d237dd47e594f789617041b0d09c66f", "description": "Used to get semantic types with given ids." }, "IfNoneMatchHeader": { "in": "header", "name": "If-None-Match", "schema": { "type": "string" }, "description": "The `ETag` value from a previous response. When it matches the current version, the server returns `304 Not Modified` instead of the full response." }, "LimitQuery": { "in": "query", "name": "limit", "schema": { "type": "integer", "format": "int32", "default": 20, "maximum": 100, "minimum": 1 }, "required": false, "description": "Number of items per page." }, "PageQuery": { "in": "query", "name": "page", "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, "required": false, "description": "Page number for pagination (1-based)." }, "ParentIdsListQuery": { "in": "query", "name": "parentIds", "schema": { "$ref": "#/components/schemas/SemanticTypeIds" }, "example": "3b179e2b028c4306ab108b68116ae639,4d237dd47e594f789617041b0d09c66f", "description": "Used to get semantic types with given parent ids." }, "SemanticTypeIdPath": { "in": "path", "name": "semanticTypeId", "schema": { "type": "string" }, "required": true, "description": "The unique identifier of the semantic type." }, "SortQuery": { "in": "query", "name": "sort", "schema": { "enum": [ "+datasetId", "-datasetId" ], "type": "string" }, "description": "Optional resource field name to sort on. Can be prefixed with +/- to determine order, defaults to (+) ascending. In URLs, \"+\" should be percent-encoded as \"%2B\"." } }, "schemas": { "ConflictResolution": { "type": "object", "required": [ "label", "strategy" ], "properties": { "label": { "type": "string", "example": "Email Address", "description": "Label of the conflicting semantic type." }, "strategy": { "enum": [ "OVERWRITE", "SKIP", "KEEP_BOTH" ], "type": "string", "example": "SKIP", "description": "`OVERWRITE`: replace the existing type with the version from the file. `SKIP`: keep the existing type unchanged, do not import. `KEEP_BOTH`: keep the existing type and create the version from the file with a deduplicated label.\n" } }, "description": "Resolution decision for a single conflicting semantic type." }, "CreateSemanticTypeCompoundRequest": { "type": "object", "required": [ "label", "type", "config" ], "properties": { "type": { "type": "string", "default": "COMPOUND", "description": "Category of the semantic type. `REGEX`, `DICTIONARY`, or `COMPOUND`. Determines which `config` schema applies." }, "label": { "type": "string", "example": "regex for semantic type", "maxLength": 200, "description": "label of semantic type" }, "config": { "$ref": "#/components/schemas/SemanticTypeCompound" }, "activated": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type can be used in data quality compute." }, "description": { "type": "string", "example": "semantic type based on regex", "maxLength": 500 }, "useForValidation": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type is used for validation." } }, "description": "Request to create a compound semantic type composed of multiple child semantic types." }, "CreateSemanticTypeDictionaryRequest": { "type": "object", "required": [ "label", "type", "config" ], "properties": { "type": { "type": "string", "default": "DICTIONARY", "description": "Category of the semantic type. `REGEX`, `DICTIONARY`, or `COMPOUND`. Determines which `config` schema applies." }, "label": { "type": "string", "example": "regex for semantic type", "maxLength": 200, "description": "label of semantic type" }, "config": { "$ref": "#/components/schemas/SemanticTypeDictionary" }, "activated": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type can be used in data quality compute." }, "description": { "type": "string", "example": "semantic type based on regex", "maxLength": 500 }, "useForValidation": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type is used for validation." } }, "description": "Request to create a semantic type that matches words against a list of dictionary values." }, "CreateSemanticTypeRegexRequest": { "type": "object", "required": [ "label", "type", "config" ], "properties": { "type": { "type": "string", "default": "REGEX", "description": "Category of the semantic type. `REGEX`, `DICTIONARY`, or `COMPOUND`. Determines which `config` schema applies." }, "label": { "type": "string", "example": "regex for semantic type", "maxLength": 200, "description": "label of semantic type" }, "config": { "$ref": "#/components/schemas/SemanticTypeRegex" }, "activated": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type can be used in data quality compute." }, "description": { "type": "string", "example": "semantic type based on regex", "maxLength": 500 }, "useForValidation": { "type": "boolean", "default": true, "example": true, "description": "When `true`, the semantic type is used for validation." } }, "description": "Request to create a semantic type that matches words against a regex pattern." }, "DatasetFieldsItem": { "type": "object", "properties": { "datasetId": { "type": "string", "description": "The unique identifier of the dataset." }, "fieldNames": { "type": "array", "items": { "type": "string" }, "description": "The list of field names in the dataset associated with the semantic type." } } }, "DatasetFieldsPageResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DatasetFieldsItem" } }, "links": { "$ref": "#/components/schemas/PaginationLinks" } } }, "DiffEntry": { "type": "object", "required": [ "fromFile", "existing" ], "properties": { "existing": { "description": "Value currently in the tenant." }, "fromFile": { "description": "Value from the import file." } }, "description": "A single field difference between the file value and the existing type." }, "Error": { "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "status": { "type": "string" } } }, "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } }, "traceId": { "type": "string" } } }, "ExportCompoundChild": { "type": "object", "required": [ "label" ], "properties": { "label": { "type": "string", "description": "Label of the child type. Primary resolution key at import time. The importer resolves children using a three-step cascade: first against types created earlier in the same import batch (by label), then against existing types in the target tenant (by label), and finally by `parentId` fallback.\n" }, "parentId": { "type": "string", "description": "Identifier of the child's parent default semantic type (Qlik-provisioned). Null for user-created children. Used as a fallback resolution key at import time: when the child's label does not match any type in the target tenant (e.g. because it was renamed after export), the importer looks up a type whose own `parentId` matches this value. If a child cannot be resolved by either label or `parentId`, the entire COMPOUND type is rejected with `IMPORT_COMPOUND_CHILDREN_NOT_FOUND`. Only that COMPOUND type is affected; the rest of the import proceeds normally (best-effort).\n" } }, "description": "Reference to a child type in a COMPOUND export. Contains resolution info (label + parentId) instead of a tenant-specific ID.\n" }, "ExportRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string", "example": "3b179e2b028c4306ab108b68116ae639", "description": "A unique identifier for a semantic type." }, "example": [ "3b179e2b028c4306ab108b68116ae639", "4d237dd47e594f789617041b0d09c66f" ], "description": "List of semantic type IDs to export. When provided, only these types are included.", "uniqueItems": true }, "types": { "type": "array", "items": { "enum": [ "REGEX", "DICTIONARY", "COMPOUND" ], "type": "string", "example": "REGEX", "description": "A semantic type category." }, "example": [ "REGEX", "DICTIONARY" ], "description": "Filter by semantic type categories. Supports multiple values for OR logic. When provided, only types matching the specified categories are included.\n", "uniqueItems": true }, "search": { "type": "string", "example": "email", "maxLength": 500, "description": "Case-insensitive substring search on label and description fields. Returns only semantic types where the label or description contains the search term. Special regex characters are automatically escaped for literal matching. Maximum length: 500 characters. Empty string returns no results.\n" }, "createdBy": { "type": "string", "example": "712020:291adc5e-c210-408b-a43a-776448c35ef4", "description": "Filter by creator user ID. When provided, only types created by this user are included." } }, "description": "Request body for exporting semantic types with optional filters." }, "ExportSemanticType": { "type": "object", "required": [ "label", "type", "useForValidation", "activated", "config" ], "properties": { "type": { "enum": [ "REGEX", "DICTIONARY", "COMPOUND" ], "type": "string" }, "label": { "type": "string", "maxLength": 200 }, "config": { "oneOf": [ { "$ref": "#/components/schemas/SemanticTypeRegex" }, { "$ref": "#/components/schemas/SemanticTypeDictionary" }, { "$ref": "#/components/schemas/ExportSemanticTypeCompound" } ] }, "activated": { "type": "boolean" }, "defaultId": { "type": "string", "description": "Identifier of the parent default semantic type (Qlik-provisioned). Null for user-created types. Used for identity preservation during cross-tenant import and as fallback for COMPOUND children resolution when labels differ across tenants.\n" }, "description": { "type": "string", "maxLength": 500 }, "useForValidation": { "type": "boolean" } }, "description": "A semantic type in the export file, stripped of internal fields." }, "ExportSemanticTypeCompound": { "type": "object", "required": [ "children" ], "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/ExportCompoundChild" } } }, "description": "COMPOUND config in the export file. Children are represented as enriched references with label and parentId for cross-tenant resolution, instead of raw IDs which are tenant-specific.\n" }, "ImportConfigDiff": { "type": "object", "properties": { "values": { "$ref": "#/components/schemas/DiffEntry" }, "children": { "$ref": "#/components/schemas/DiffEntry" }, "validationContent": { "$ref": "#/components/schemas/DiffEntry" }, "validationPattern": { "$ref": "#/components/schemas/DiffEntry" }, "validationCriteria": { "$ref": "#/components/schemas/DiffEntry" } }, "description": "Type-specific config differences. Only the fields relevant to the type's category are present (REGEX → validationContent/validationPattern, DICTIONARY → validationCriteria/values, COMPOUND → children), and only when they differ.\n" }, "ImportConflictResponse": { "type": "object", "required": [ "code", "message", "types" ], "properties": { "code": { "type": "string", "example": "IMPORT_CONFLICT" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ImportTypeStatus" }, "description": "Every type from the import file with its status. `CONFLICT` types include a `diff` showing field-level differences. `ERROR` types include an `error` message describing the validation failure. `DUPLICATE` types are either repeated labels within the same file, or types whose definition is identical to one already in the tenant (auto-skipped, no conflict resolution needed).\n" }, "message": { "type": "string", "example": "Conflicts: 2 of 10, Unchanged: 3." } }, "description": "Returned when conflicts are detected and no resolutions were provided. Contains ALL types from the import file, each with a status indicating whether it is new or conflicts with an existing type.\n" }, "ImportItemError": { "type": "object", "required": [ "label", "code", "message" ], "properties": { "code": { "type": "string", "description": "Application error code identifying the failure reason." }, "label": { "type": "string", "description": "Label of the semantic type that failed." }, "message": { "type": "string", "description": "Human-readable error description in English." } }, "description": "Error detail for a single semantic type that could not be imported." }, "ImportReport": { "type": "object", "required": [ "summary", "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ImportItemError" } }, "summary": { "$ref": "#/components/schemas/ImportSummary" } }, "description": "Result of a best-effort import operation." }, "ImportRequest": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "object", "example": { "exportedAt": "2024-01-01T00:00:00Z", "exportFormat": "QlikSemanticTypesExport", "semanticTypes": [] }, "description": "The export file payload as-is. Format is detected from the `exportFormat` field. Accepts `QlikSemanticTypesExport` (Qlik native) or `DQDictionaryImportExport` (Talend legacy).\n" }, "skipConfirmation": { "type": "boolean", "default": false, "description": "Controls preview vs. one-shot import when no `conflictResolutions` are supplied. When `false` (default) the call is a **preview**: the file is analysed and a per-type conflict/summary body is returned (HTTP 200) without importing anything. When `true` the import is attempted **one-shot**: if real conflicts or in-file duplicates exist the conflict body is returned (HTTP 200) and nothing is imported; otherwise all types are imported (HTTP 201). Ignored when `conflictResolutions` are provided (those always apply the import).\n" }, "conflictResolutions": { "type": "array", "items": { "$ref": "#/components/schemas/ConflictResolution" }, "nullable": true, "description": "Per-type conflict resolution. Each entry maps a conflicting label to its strategy. Labels not listed fall back to `defaultConflictStrategy`. Omit entirely (or send `null`) on the first call to trigger conflict detection. Sending an array — even an empty one — applies the import, using `defaultConflictStrategy` for every conflict not listed.\n" }, "defaultConflictStrategy": { "enum": [ "OVERWRITE", "SKIP", "KEEP_BOTH" ], "type": "string", "default": "SKIP", "description": "Fallback strategy applied to conflicting types not listed in `conflictResolutions`. Defaults to `SKIP`.\n" } }, "description": "Import request wrapping the export file and optional conflict resolutions." }, "ImportStatusDetail": { "type": "object", "required": [ "count", "labels", "items" ], "properties": { "count": { "type": "integer", "description": "Number of types in this category." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ImportStatusItem" }, "description": "Affected semantic types paired with their persisted resource id. Ids are present for created, updated, skipped and duplicate outcomes, and null for errored types that were never persisted.\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "Labels of the affected semantic types." } }, "description": "Count and affected types for one import outcome." }, "ImportStatusItem": { "type": "object", "required": [ "label" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Persisted resource id of the semantic type, or null when no resource exists for this outcome (for example, an errored type that was never created).\n" }, "label": { "type": "string", "description": "Label of the affected semantic type." } }, "description": "A single affected semantic type with its persisted resource id when available." }, "ImportSummary": { "type": "object", "required": [ "totalCreated", "updated", "skipped", "errored", "duplicates" ], "properties": { "errored": { "$ref": "#/components/schemas/ImportStatusDetail" }, "skipped": { "$ref": "#/components/schemas/ImportStatusDetail" }, "updated": { "$ref": "#/components/schemas/ImportStatusDetail" }, "duplicates": { "$ref": "#/components/schemas/ImportStatusDetail" }, "totalCreated": { "$ref": "#/components/schemas/ImportStatusDetail" } }, "description": "Aggregate counts and per-status label details for the import result. Each status group includes a count and the list of affected type labels.\n" }, "ImportTypeDiff": { "type": "object", "properties": { "config": { "$ref": "#/components/schemas/ImportConfigDiff" }, "category": { "$ref": "#/components/schemas/DiffEntry" }, "activated": { "$ref": "#/components/schemas/DiffEntry" }, "description": { "$ref": "#/components/schemas/DiffEntry" }, "useForValidation": { "$ref": "#/components/schemas/DiffEntry" } }, "description": "Field-by-field comparison between the type from the import file and the existing type in the tenant. Only present when status is `CONFLICT`. Each field shows the value from the file and the existing value so the user can make an informed OVERWRITE / SKIP / KEEP_BOTH decision.\n" }, "ImportTypeStatus": { "type": "object", "required": [ "label", "type", "status" ], "properties": { "diff": { "$ref": "#/components/schemas/ImportTypeDiff" }, "type": { "enum": [ "REGEX", "DICTIONARY", "COMPOUND" ], "type": "string", "description": "Category of the semantic type." }, "error": { "type": "string", "description": "Human-readable error message. Only present when status is `ERROR`.\n" }, "label": { "type": "string", "description": "Label of the semantic type." }, "status": { "enum": [ "NEW", "CONFLICT", "ERROR", "DUPLICATE" ], "type": "string", "description": "`NEW`: no type with this label exists in the tenant. `CONFLICT`: a type with this label already exists but differs from the imported version. `ERROR`: the type has a validation error (missing field, invalid regex, etc.). `DUPLICATE`: the type is a duplicate — either another type with the same label appears earlier in the import file, or the imported type is identical to an existing type in the tenant (all user-visible fields match; auto-skipped with no conflict resolution needed).\n" }, "errorCode": { "enum": [ "IMPORT_REGEX_PATTERN_MISSING", "IMPORT_REGEX_PATTERN_TOO_LONG", "IMPORT_REGEX_PATTERN_INVALID", "IMPORT_DICTIONARY_VALUES_MISSING", "IMPORT_DICTIONARY_VALUE_BLANK", "IMPORT_COMPOUND_CHILDREN_MISSING", "IMPORT_COMPOUND_CHILDREN_NOT_FOUND", "IMPORT_DICTIONARY_VALIDATION_CRITERIA_INVALID" ], "type": "string", "description": "Machine-readable error code. Only present when status is `ERROR`." } }, "description": "Status of a single type from the import file." }, "Link": { "type": "object", "nullable": true, "properties": { "href": { "type": "string", "nullable": true, "description": "The URL for the link." } }, "description": "A pagination link object." }, "PaginationLinks": { "type": "object", "properties": { "last": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "first": { "$ref": "#/components/schemas/Link" } }, "description": "JSON:API pagination links." }, "PatchSemanticTypeRequest": { "type": "array", "items": { "type": "object", "required": [ "op", "path" ], "properties": { "op": { "enum": [ "replace" ], "type": "string" }, "path": { "enum": [ "/label", "/description", "/useForValidation", "/activated", "/config/validationContent", "/config/validationPattern", "/config/validationCriteria", "/config/values", "/config/children" ], "type": "string" }, "value": { "$ref": "#/components/schemas/PatchSemanticTypeRequestValue" } } } }, "PatchSemanticTypeRequestValue": { "oneOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": {} } ], "nullable": true, "description": "The new value to apply at the given `path`. The accepted type depends on the target path: a string for `/label`, `/description`, `/config/validationContent`, `/config/validationPattern`, and `/config/validationCriteria`; a boolean for `/useForValidation` and `/activated`; an array for `/config/values` and `/config/children`." }, "SemanticTypeCompound": { "type": "object", "required": [ "children" ], "properties": { "children": { "type": "array", "items": { "type": "string", "example": "a0c94cd5-9c84-4d16-8165-0d65d064a322", "description": "Identifier of a child semantic type." }, "default": [] } }, "description": "A coumpound of multiple kinds of semantic types" }, "SemanticTypeDictionary": { "type": "object", "required": [ "values" ], "properties": { "values": { "type": "array", "items": { "type": "string", "example": "blue", "description": "Values for dictionary" } }, "validationCriteria": { "enum": [ "EXACT_VALUE", "IGNORE_CASE_AND_ACCENTS" ], "type": "string", "default": "IGNORE_CASE_AND_ACCENTS", "description": "one of EXACT_VALUE / IGNORE_CASE_AND_ACCENTS,\nEXACT_VALUE: matches only the exact values in dictionary,\nIGNORE_CASE_AND_ACCENTS: case and accents are ignored\n" } }, "description": "A semantic type for words matching a value in the list of values" }, "SemanticTypeIds": { "type": "array", "items": { "type": "string", "example": "3b179e2b028c4306ab108b68116ae639", "description": "Semantic type id." }, "description": "List of semantic type ids.", "uniqueItems": true }, "SemanticTypeListResponse": { "type": "object", "properties": { "data": { "items": { "$ref": "#/components/schemas/SemanticTypeResponse" } } } }, "SemanticTypeRegex": { "type": "object", "required": [ "validationPattern" ], "properties": { "validationContent": { "enum": [ "ANY_CHARACTER", "ALPHABETIC", "NUMERIC" ], "type": "string", "default": "ANY_CHARACTER", "example": "ANY_CHARACTER", "description": "one of ANY_CHARACTER / ALPHABETIC / NUMERIC,\nANY_CHARACTER: validates all characters,\nALPHABETIC: validates only alphabetic content,\nNUMERIC: validate only number\n" }, "validationPattern": { "type": "string", "example": "^(\\\\S+)\\\\s+(\\\\S+)$", "description": "Regular expression" } }, "description": "A semantic type for words matching a regex pattern" }, "SemanticTypeResponse": { "type": "object", "example": { "type": "REGEX", "label": "Qlik email", "config": { "validationContent": "ANY_CHARACTER", "validationPattern": "^[a-z]{3}@qlik\\.com$" }, "activated": true, "createdAt": "2025-07-16T13:38:03Z", "createdBy": "685bc460dcdf02ef734cd2e6", "updatedAt": "2025-07-16T13:38:03Z", "updatedBy": "685bc460dcdf02ef734cd2e6", "description": "qlik email is a trigram followed by @qlik", "useForValidation": true }, "required": [ "id", "label", "type", "useForValidation", "activated", "createdAt", "createdBy", "updatedAt", "updatedBy", "config" ], "properties": { "id": { "type": "string" }, "type": { "enum": [ "REGEX", "DICTIONARY", "COMPOUND" ], "type": "string" }, "label": { "type": "string" }, "config": { "oneOf": [ { "$ref": "#/components/schemas/SemanticTypeRegex" }, { "$ref": "#/components/schemas/SemanticTypeDictionary" }, { "$ref": "#/components/schemas/SemanticTypeCompound" } ] }, "parentId": { "type": "string", "description": "Parent semantic type identifier. This field is omitted from the default response and is only returned when explicitly requested with `fields=parentId`." }, "activated": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "example": "2025-07-16T13:38:03Z" }, "createdBy": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time", "example": "2025-07-16T13:38:03Z" }, "updatedBy": { "type": "string" }, "description": { "type": "string" }, "useForValidation": { "type": "boolean" } } }, "SemanticTypesExportEnvelope": { "type": "object", "required": [ "exportFormat", "version", "semanticTypes" ], "properties": { "version": { "type": "string", "example": "1.0", "description": "Schema version for forward compatibility." }, "exportFormat": { "enum": [ "QlikSemanticTypesExport" ], "type": "string", "description": "Format identifier for auto-detection on import." }, "exportedCount": { "type": "integer", "format": "int32", "example": 42, "description": "Total number of semantic types included in this export. Helps API consumers quickly determine export size without parsing the entire array.\n" }, "semanticTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ExportSemanticType" } } }, "description": "Self-describing export envelope for Qlik Cloud semantic types." } } }, "servers": [ { "url": "https://{tenant}.{region}.qlikcloud.com", "variables": { "region": { "default": "us", "description": "The region the tenant is hosted in" }, "tenant": { "default": "your-tenant", "description": "Name of the tenant that will be called" } } } ] }