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.
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.
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.
Returns the definition of a single semantic type identified by its ID, including its configuration (regex, dictionary, or compound rules).
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.
Retrieves all semantic types for a tenant. Supports conditional requests via the If-None-Match header.
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.
Conflict handling is controlled by the skipConfirmation flag and the optional conflictResolutions array:
Preview (skipConfirmation false/absent, no conflictResolutions):
the file is analysed but nothing is imported. Returns 200 with a
per-type conflict/summary body. Re-submit with skipConfirmation=true
or conflictResolutions to actually apply the import.
One-shot (skipConfirmation=true, no conflictResolutions):
if real conflicts or in-file duplicates exist, returns 200 with the
conflict body and imports nothing; otherwise the import is applied and
201 is returned with the import report.
Resolved (conflictResolutions provided): the import is applied using
the per-label strategies, falling back to defaultConflictStrategy
(defaults to SKIP) for unlisted labels. Returns 201 in both cases
(conflicts present or not), with the import report.
Import is best-effort: each type is processed independently. Failures are logged in the response report without blocking other types.
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.
Clears the cache for semantic-types api requests.