--- source: https://qlik.dev/toolkits/qlik-cli/glossary/glossary-import-glossary/ last_updated: 2026-06-03T09:30:31+02:00 --- # glossary import-glossary ## qlik glossary import-glossary Imports a glossary from file ### Synopsis Creates a new or updates an existing glossary, including categories and terms, based on a glossary definition file. Supported formats are currently, qlik, atlan and atlas. ``` qlik glossary import-glossary [flags] ``` ### Options ``` --categories unknowns (Deprecated) Array of JSON-objects to send as the property categories. --categories-description string --categories-id string The id for resolving updates in future imports/updates. Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded. --categories-name string The name of the category. May not be identical to another category belonging to the same parent. --categories-parentId string --categories-stewardDetails-email string --categories-stewardDetails-name string --categories-stewardDetails-userId string --categories-stewards strings --description string -f, --file file Read request body from the specified file -h, --help help for import-glossary --importerAsFallbackSteward Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. --interval int Duration in seconds to wait between retries, at least 1 (default 1) --lookupUserOnEmail Using email in the steward fields to lookup userIds in the identity service --name string --overview string Overview of the glossary. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format. -q, --quiet Return only IDs from the command --raw Return original response from server without any processing --retry int Number of retries to do before failing, max 10 --spaceId-in-body string --spaceId-in-query string The spaceId (leave blank or omit for personal) --tags strings --termTemplate-relatedInformation string Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format. --terms unknowns (Deprecated) Array of JSON-objects to send as the property terms. --terms-abbreviation string --terms-categories strings Categories that the term belongs to. Refers to the ˋidˋ property of the category object --terms-description string --terms-id string The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index --terms-linksTo-resourceId string The unique identifier of the resource (app or dataset) to link to the term. --terms-linksTo-resourceType string The type of resource being linked to the term. Allowed values: "app", "dataset" --terms-linksTo-subResourceId string Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. --terms-linksTo-subResourceName string Required when subResourceType or subResourceId is provided. The display name of the subresource. --terms-linksTo-subResourceType string Required when subResourceId or subResourceName is provided. The type of the subresource. Allowed values: "master_dimension", "master_measure", "field" --terms-linksTo-type string The type of relationship between the term and the linked resource: - ˋdefinitionˋ: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means) - ˋrelatedˋ: Use when the term is generally related to the resource but doesn't formally define it Allowed values: "definition", "related" --terms-name string --terms-owner-email string --terms-owner-name string --terms-owner-userId string --terms-relatesTo-termId string The unique identifier of the related term. NOTE! In case of import the string refers to the index of the term in the import document. --terms-relatesTo-type string How the term related to the other object Allowed values: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" --terms-stewardDetails-email string --terms-stewardDetails-name string --terms-stewardDetails-userId string --terms-stewards-email string --terms-stewards-name string --terms-stewards-userId string --terms-tags strings ``` ### Options inherited from parent commands ``` -c, --config string path/to/config.yml where parameters can be set instead of on the command line --context string Name of the context used when connecting to Qlik Associative Engine --headers stringToString HTTP headers to use when connecting to Qlik Associative Engine (default []) --insecure Allow connecting to hosts with self-signed certificates --json Returns output in JSON format, if possible. Disables verbose and traffic output -s, --server string URL to Qlik Cloud or directly to a Qlik Associative Engine --server-type string The type of server you are using: cloud, Windows (Enterprise on Windows) or engine -v, --verbose Log extra information ```