Type Alias SemanticTypesAPI

type SemanticTypesAPI = {
    clearCache: typeof semanticTypes.clearCache;
    exportSemanticTypes: typeof exportSemanticTypes;
    importSemanticTypes: typeof importSemanticTypes;
}
Index
clearCache: typeof semanticTypes.clearCache

Clears the cache for semantic-types api requests.

exportSemanticTypes: typeof exportSemanticTypes

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.

an object with the body content

ExportSemanticTypesHttpError

importSemanticTypes: typeof importSemanticTypes

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.

an object with the body content

ImportSemanticTypesHttpError