data-governance data-contract dataset expectation ls
qlik data-governance data-contract dataset expectation ls
Get dataset expectations
Synopsis
Returns the list of all expectations of the global catalog, merged with the dataset’s activated ones, with their current activation status, configured thresholds or bounds, latest actual value and last evaluation result. The catalog holds trust_score (8 dimensions: global, validity, completeness, accuracy, diversity, discoverability, usage, timeliness), data_profile (1 expectation: volume) and schema (1 expectation: structure, experimental). Each item has the four top-level fields category, name, status, updatedAt and exactly one category-specific details sub-object (trustScore, dataProfile or schema) holding every category-specific field. If the dataset has no data contract, the operation still returns 200 with the default, non-activated expectations. For non-activated expectations the actual value (Trust Score) or row count (volume) is fetched live while the response is built and is omitted if it cannot be retrieved.
When schema compliance is enabled for the tenant, the schema / structure expectation is listed too (experimental), with every non-deleted field of the activated schema nested under it in schema.fields (experimental), sorted by name in case-sensitive order — never as sibling items of their own: this response never has a category: field item. The schema expectation also stores the name of every field it knows, deleted ones included (fieldNames), for the drift detection of later tickets; no response exposes it.
Order, the same on every page: the top-level items, ACTIVATED ones before the others; the schema item is one of them. When schema compliance is disabled (or the flag service cannot answer), the schema entry, stored or NOT_ACTIVATED placeholder, is omitted from this response, from suggest and from lookup; a schema activated before the flag was turned off is kept, only hidden, and so are its fields, nested under it.
Pagination (experimental): at most limit items per page, in this order, which never changes from one page to the next. links.next.href leads to the next page and is null on the last one; a page that ends exactly on the last item also has next: null, so no next link ever leads to an empty page. links.prev.href leads to the previous page, which holds the limit items before the current one or fewer, and is null on the first. There is no page number: the Qlik pagination guidelines are cursor-based, so call the links as is. meta.count is the total number of top-level items over all pages, the same on every page of one pass. Only the top-level items are paged and counted: the fields nested under schema.fields are never paged nor counted, and the page that holds the schema item holds every one of its fields regardless of limit — a deliberate exception, since a cap would silently drop fields from the only API that lists them; a dataset with many fields can return 1,000 or more of them in that one schema item. When schema compliance is disabled there is no schema item, so every item comes on a single page with links.prev and links.next both null.
qlik data-governance data-contract dataset expectation ls <datasetId> [flags]Options
-h, --help help for ls --interval int Duration in seconds to wait between retries, at least 1 (default 1) -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 10Options 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