ancoreMate Catalog (Preview)

Maintain the data catalog of Qlik Cloud®: data stores, data assets and datasets, and business glossaries with categories and terms, including import and export. Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name ancoreSoft
URL https://ancorecloud.com/
Email support@ancoresoft.com
Connector Metadata
Publisher ancoreSoft
Website https://ancorecloud.com/
Privacy policy https://ancoresoft.com/legal/ancoremate/privacy/
Categories Data

ancoreMate Catalog

Maintain the data catalog of Qlik Cloud®: data stores, data assets and datasets, and business glossaries with categories and terms, including import and export.

Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.

Publisher

ancoreSoft

Prerequisites

  • An ancoreCloud account with an ancoreMate subscription. See https://ancorecloud.com/ for details and https://docs.ancoresoft.com/ for the documentation.
  • A Qlik Cloud user with access to the content you want to automate. No OAuth client, client ID or API key needs to be created in Qlik Cloud.

Supported operations

Change glossary term status

Sets the status of a glossary term, for example verified.

Create data asset

Creates a data asset in a data store.

Create data store

Creates a data store in the catalog.

Create dataset

Creates a dataset in a data asset.

Create glossary

Creates a business glossary.

Create glossary category

Creates a category in a glossary.

Create glossary term

Creates a term in a glossary.

Delete data asset

Deletes a data asset.

Delete dataset

Deletes a dataset.

Delete glossary

Deletes a glossary with its categories and terms.

Delete glossary category

Deletes a category of a glossary.

Delete glossary term

Deletes a term of a glossary.

Export glossary

Exports a glossary with its categories and terms as JSON.

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

Get data asset

Returns a data asset.

Get data store

Returns a data store.

Get dataset

Returns a dataset with its schema.

Get glossary

Returns a business glossary.

Get glossary category

Returns a category of a glossary.

Get glossary term

Returns a term of a glossary.

Import glossary

Creates a glossary from an exported glossary.

List data assets

Lists the data assets of a data store.

List data stores

Lists the data stores of the catalog.

List datasets

Lists the datasets of a data asset.

List glossaries

Lists the business glossaries.

List glossary categories

Lists the categories of a glossary.

List glossary terms

Lists the terms of a glossary.

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Update data asset

Replaces the attributes of a data asset.

Update data store

Replaces the attributes of a data store.

Update dataset

Replaces the attributes of a dataset.

Update glossary

Replaces the name, description and settings of a glossary.

Update glossary category

Replaces the name and description of a glossary category.

Update glossary term

Replaces the definition and attributes of a glossary term.

Obtaining credentials

  1. Create a connection and select Sign in.
  2. Sign in with your ancoreCloud account.
  3. The first time, enter your Qlik Cloud tenant, for example company.eu.qlikcloud.com, sign in at Qlik Cloud and approve the access for ancoreMate. Later sign-ins list the Qlik Cloud connections of your ancoreCloud account: continue with one of them, or add another tenant or Qlik user. Each connection works with the Qlik Cloud connection chosen in its sign-in; the others stay as they are.
  4. If your Qlik Cloud administrators require it, an administrator approves ancoreMate once in the Qlik Cloud administration (Integrations > OAuth).

Getting started

Use List datasets and List data assets to build an inventory of the data in the tenant, or the glossary actions to keep business terms up to date.

Known issues and limitations

  • Creating and changing glossaries needs a Qlik Cloud user with the permission to manage glossaries, for example the Steward role.
  • Only Qlik Cloud tenants are supported; Qlik Sense client-managed (on-premises) deployments are not supported.
  • Qlik Cloud rate limits apply. When Qlik Cloud limits requests, the action fails with status 429; the flow's retry policy retries it automatically.
  • Each connection works with one Qlik Cloud tenant and Qlik user, chosen in its sign-in. To work with several tenants or Qlik users, for example development and production, create one connection per tenant or user; a flow can use several of them.

Deployment instructions

Use the instructions to deploy a custom connector with the files apiDefinition.swagger.json and apiProperties.json of this folder.

Actions

Change glossary term status

Sets the status of a glossary term, for example verified.

Create data asset

Creates a data asset in a data store.

Create data store

Creates a data store in the catalog.

Create dataset

Creates a dataset in a data asset.

Create glossary

Creates a business glossary.

Create glossary category

Creates a category in a glossary.

Create glossary term

Creates a term in a glossary.

Delete data asset

Deletes a data asset.

Delete dataset

Deletes a dataset.

Delete glossary

Deletes a glossary with its categories and terms.

Delete glossary category

Deletes a category of a glossary.

Delete glossary term

Deletes a term of a glossary.

Export glossary

Exports a glossary with its categories and terms as JSON.

Get data asset

Returns a data asset.

Get data store

Returns a data store.

Get dataset

Returns a dataset with its schema.

Get glossary

Returns a business glossary.

Get glossary category

Returns a category of a glossary.

Get glossary term

Returns a term of a glossary.

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

Import glossary

Creates a glossary from an exported glossary.

List data assets

Lists the data assets of a data store.

List data stores

Lists the data stores of the catalog.

List datasets

Lists the datasets of a data asset.

List glossaries

Lists the business glossaries.

List glossary categories

Lists the categories of a glossary.

List glossary terms

Lists the terms of a glossary.

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Update data asset

Replaces the attributes of a data asset.

Update data store

Replaces the attributes of a data store.

Update dataset

Replaces the attributes of a dataset.

Update glossary

Replaces the name, description and settings of a glossary.

Update glossary category

Replaces the name and description of a glossary category.

Update glossary term

Replaces the definition and attributes of a glossary term.

Change glossary term status

Sets the status of a glossary term, for example verified.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Term ID
termId True string

The term id.

Status
status True string

The status to update to.

Returns

A glossary term.

Create data asset

Creates a data asset in a data store.

Parameters

Name Key Required Type Description
ID
id string

Only required when updating the resource.

Name
name string

The name.

Tags
tags array of string

The tags.

App ID
appId string

The app id.

App Type
appType True string

The app type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Data Freshness
dataFreshness date-time

The date-time when the source data was last changed.

ID
id True string

The id.

Technical Name
technicalName True string

The technical name.

Technical Description
technicalDescription string

The technical description.

Returns

A data asset.

Body
DataAsset

Create data store

Creates a data store in the catalog.

Parameters

Name Key Required Type Description
ID
id string

Only required when updating the resource.

URI
uri string

The uri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type True string

The type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Technical Name
technicalName True string

The technical name.

Technical Description
technicalDescription string

The technical description.

Returns

A data store.

Body
DataStore

Create dataset

Creates a dataset in a data asset.

Parameters

Name Key Required Type Description
ID
id string

Only required when updating the resource.

QRI
qri True string

NOTE: this will be deprecated after migration to secureQri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type string

The type.

Anomalies
anomalies array of string

Anomalies associated with this schema.

Name
name True string

The name.

Tags
Tags object

An item.

Alias
alias string

Alias of the field.

Orphan
orphan boolean

The orphan.

Data Type
dataType True object

The data type.

Nullable
nullable boolean

The nullable.

User Tags
User Tags object

An item.

Encrypted
encrypted boolean

The encrypted.

Sensitive
sensitive boolean

The sensitive.

Primary Key
primaryKey boolean

The primary key.

Properties
properties object

The properties.

Description
description string

The description.

Ordinal Position In Key
ordinalPositionInKey integer

The ordinal position in key.

Schema Name
schemaName string

The schema name.

Load Options
loadOptions object

Options for loading files.

Override Schema Anomalies
overrideSchemaAnomalies boolean

The override schema anomalies.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Secure QRI
secureQri True string

The secure qri.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Size
size integer

The size.

Status
status string

The status.

End Date
endDate date-time

The end date.

Location
location string

The location.

Row Count
rowCount integer

The row count.

Start Date
startDate date-time

The start date.

Log Message
logMessage string

The log message.

Table Owner
tableOwner string

The table owner.

Last Load Time
lastLoadTime date-time

The last load time.

Content Updated
contentUpdated boolean

The content updated.

Last Update Time
lastUpdateTime date-time

The last update time.

Table Name
tableName string

The table name.

Selection Script
selectionScript string

The selection script.

Additional Properties
additionalProperties object

The additional properties.

ID
id True string

The id.

ID
id True string

The id.

Technical Name
technicalName True string

The technical name.

App Type Override
appTypeOverride string

Optional override of DataAsset appType.

Anomalies
anomalies array of string

Anomalies associated with this schema.

Data Fields
Data Fields object

An item.

Schema Name
schemaName string

The schema name.

Load Options
loadOptions object

Options for loading files.

Override Schema Anomalies
overrideSchemaAnomalies boolean

The override schema anomalies.

Technical Description
technicalDescription string

The technical description.

Created By Connection ID
createdByConnectionId string

The connectionId that created the Dataset.

Returns

A dataset.

Body
Dataset

Create glossary

Creates a business glossary.

Parameters

Name Key Required Type Description
Name
name True string

Name of the glossary.

Tags
tags array of string

List of tags for glossary.

Space ID
spaceId string

Unique unique identifier of the space to contain the glossary.

Overview
overview string

Overview of the glossary content.

Description
description string

Description of the glossary.

Related Information
relatedInformation string

Template text for new terms.

Returns

A glossary.

Body
Glossary

Create glossary category

Creates a category in a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Name
name string

The name of the category.

Parent ID
parentId string

The parent id.

Stewards
stewards array of string

This list contains the UIDs of the stewards of the category.

Description
description string

The description.

Returns

A glossary category.

Create glossary term

Creates a term in a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Name
name True string

The name.

Tags
tags array of string

The tags.

Type
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.

Resource ID
resourceId True string

The unique identifier of the resource (app or dataset) to link to the term.

Resource Type
resourceType True string

The type of resource being linked to the term.

Sub Resource ID
subResourceId string

Required when subResourceType or subResourceName is provided.

Sub Resource Name
subResourceName string

Required when subResourceType or subResourceId is provided.

Sub Resource Type
subResourceType string

Required when subResourceId or subResourceName is provided.

Stewards
stewards array of string

This list contain the UIDs for the term's stewards.

Type
type True string

How the term related to the other object.

Term ID
termId True string

The unique identifier of the related term.

Categories
categories array of string

Category Ids that the term belongs to.

Description
description string

The description.

Abbreviation
abbreviation string

The abbreviation.

Related Information
relatedInformation string

Related information for the term.

Returns

A glossary term.

Delete data asset

Deletes a data asset.

Parameters

Name Key Required Type Description
Data asset ID
dataAssetId True string

The ID of the data asset.

Delete dataset

Deletes a dataset.

Parameters

Name Key Required Type Description
Dataset ID
datasetId True string

The ID of the dataset.

Delete glossary

Deletes a glossary with its categories and terms.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The id of the glossary to delete.

Delete glossary category

Deletes a category of a glossary.

Parameters

Name Key Required Type Description
Category ID
categoryId True string

The id for the category to delete.

Glossary ID
glossaryId True string

The id of the glossary.

Delete glossary term

Deletes a term of a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Term ID
termId True string

The term id.

Export glossary

Exports a glossary with its categories and terms as JSON.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Returns

The result of export glossary.

Get data asset

Returns a data asset.

Parameters

Name Key Required Type Description
Data Asset ID
dataAssetId True string

The data asset id.

Returns

A data asset.

Body
DataAsset

Get data store

Returns a data store.

Parameters

Name Key Required Type Description
Data Store ID
dataStoreId True string

The data store id.

Returns

A data store.

Body
DataStore

Get dataset

Returns a dataset with its schema.

Parameters

Name Key Required Type Description
Dataset ID
datasetId True string

The dataset id.

Returns

A dataset.

Body
Dataset

Get glossary

Returns a business glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The id of the glossary to retrieve.

Returns

A glossary.

Body
Glossary

Get glossary category

Returns a category of a glossary.

Parameters

Name Key Required Type Description
Category ID
categoryId True string

The category id.

Glossary ID
glossaryId True string

The glossary id.

Returns

A glossary category.

Get glossary term

Returns a term of a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Term ID
termId True string

The term id.

Returns

A glossary term.

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

Returns

The connection between ancoreMate and Qlik Cloud.

Body
Connection

Import glossary

Creates a glossary from an exported glossary.

Parameters

Name Key Required Type Description
Importer As Fallback Steward
importerAsFallbackSteward boolean

Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service.

Lookup User On Email
lookupUserOnEmail boolean

Using email in the steward fields to lookup userIds in the identity service.

Space ID
spaceId string

The spaceId (leave blank or omit for personal).

Name
name string

The name.

Tags
tags array of string

The tags.

ID
id string

The id of the term.

Name
name string

The name.

Tags
tags array of string

The tags.

Owner
Owner object

An item.

Links To
Links To object

Describes links to other data assets such as analytics applications or dataset.

Stewards
Stewards object

An item.

Relates To
Relates To object

An item.

Categories
categories array of string

Categories that the term belongs to.

Description
description string

The description.

Abbreviation
abbreviation string

The abbreviation.

Steward Details
Steward Details object

An item.

Space ID
spaceId string

The space id.

Overview
overview string

Overview of the glossary.

ID
id string

The id for resolving updates in future imports/updates.

Name
name string

The name of the category.

Parent ID
parentId string

The parent id.

Stewards
stewards array of string

The stewards.

Description
description string

The description.

Steward Details
Steward Details object

An item.

Description
description string

The description.

Related Information
relatedInformation string

Template text for new terms.

Returns

A glossary.

Body
Glossary

List data assets

Lists the data assets of a data store.

Parameters

Name Key Required Type Description
Data Store ID
dataStoreId True string

Comma-separated data store IDs or * to include all data stores.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of data asset items.

List data stores

Lists the data stores of the catalog.

Parameters

Name Key Required Type Description
Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of data store items.

List datasets

Lists the datasets of a data asset.

Parameters

Name Key Required Type Description
Data Asset ID
dataAssetId True string

Comma-separated data asset IDs or * to include all data assets.

Data Store ID
dataStoreId True string

Comma-separated data store IDs or * to include all data stores.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of dataset items.

List glossaries

Lists the business glossaries.

Parameters

Name Key Required Type Description
Sort
sort string

Optional resource field name to sort on, eg.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of glossary items.

List glossary categories

Lists the categories of a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Sort
sort string

Optional resource field name to sort on, eg.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of glossary category items.

List glossary terms

Lists the terms of a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Filter
filter string

Optional SCIM filter to be used to filter terms Usable fields are - id - name - relatedInformation - description - abbreviation - tags - stewards - status - categories.

Sort
sort string

Optional resource field name to sort on, eg.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of glossary term items.

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Parameters

Name Key Required Type Description
Method
method True string

The HTTP method.

Path
path True string

The path below /api/v1/, for example spaces or apps/1234/reloads/logs.

Query
query string

Query parameters as in a URL, for example limit=10&name=Sales.

Body
body object

The JSON body for POST, PUT, PATCH and DELETE, for example the IDs of the items to delete.

Returns

The JSON response of Qlik Cloud, unchanged.

response
object

Update data asset

Replaces the attributes of a data asset.

Parameters

Name Key Required Type Description
Data Asset ID
dataAssetId True string

The data asset id.

ID
id string

Only required when updating the resource.

Name
name string

The name.

Tags
tags array of string

The tags.

App ID
appId string

The app id.

App Type
appType True string

The app type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Data Freshness
dataFreshness date-time

The date-time when the source data was last changed.

ID
id True string

The id.

Technical Name
technicalName True string

The technical name.

Technical Description
technicalDescription string

The technical description.

Returns

A data asset.

Body
DataAsset

Update data store

Replaces the attributes of a data store.

Parameters

Name Key Required Type Description
Data Store ID
dataStoreId True string

The data store id.

ID
id string

Only required when updating the resource.

URI
uri string

The uri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type True string

The type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Technical Name
technicalName True string

The technical name.

Technical Description
technicalDescription string

The technical description.

Returns

A data store.

Body
DataStore

Update dataset

Replaces the attributes of a dataset.

Parameters

Name Key Required Type Description
Dataset ID
datasetId True string

The dataset id.

ID
id string

Only required when updating the resource.

QRI
qri True string

NOTE: this will be deprecated after migration to secureQri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type string

The type.

Anomalies
anomalies array of string

Anomalies associated with this schema.

Name
name True string

The name.

Tags
Tags object

An item.

Alias
alias string

Alias of the field.

Orphan
orphan boolean

The orphan.

Data Type
dataType True object

The data type.

Nullable
nullable boolean

The nullable.

User Tags
User Tags object

An item.

Encrypted
encrypted boolean

The encrypted.

Sensitive
sensitive boolean

The sensitive.

Primary Key
primaryKey boolean

The primary key.

Properties
properties object

The properties.

Description
description string

The description.

Ordinal Position In Key
ordinalPositionInKey integer

The ordinal position in key.

Schema Name
schemaName string

The schema name.

Load Options
loadOptions object

Options for loading files.

Override Schema Anomalies
overrideSchemaAnomalies boolean

The override schema anomalies.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Secure QRI
secureQri True string

The secure qri.

Properties
properties object

A Map of name-value pairs.

Description
description string

The description.

Size
size integer

The size.

Status
status string

The status.

End Date
endDate date-time

The end date.

Location
location string

The location.

Row Count
rowCount integer

The row count.

Start Date
startDate date-time

The start date.

Log Message
logMessage string

The log message.

Table Owner
tableOwner string

The table owner.

Last Load Time
lastLoadTime date-time

The last load time.

Content Updated
contentUpdated boolean

The content updated.

Last Update Time
lastUpdateTime date-time

The last update time.

Table Name
tableName string

The table name.

Selection Script
selectionScript string

The selection script.

Additional Properties
additionalProperties object

The additional properties.

ID
id True string

The id.

ID
id True string

The id.

Technical Name
technicalName True string

The technical name.

App Type Override
appTypeOverride string

Optional override of DataAsset appType.

Anomalies
anomalies array of string

Anomalies associated with this schema.

Data Fields
Data Fields object

An item.

Schema Name
schemaName string

The schema name.

Load Options
loadOptions object

Options for loading files.

Override Schema Anomalies
overrideSchemaAnomalies boolean

The override schema anomalies.

Technical Description
technicalDescription string

The technical description.

Created By Connection ID
createdByConnectionId string

The connectionId that created the Dataset.

Returns

A dataset.

Body
Dataset

Update glossary

Replaces the name, description and settings of a glossary.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The id of the glossary to update.

Name
name True string

Name of the glossary.

Tags
tags array of string

List of tags for glossary.

Space ID
spaceId string

Unique unique identifier of the space to contain the glossary.

Overview
overview string

Overview of the glossary content.

Description
description string

Description of the glossary.

Related Information
relatedInformation string

Template text for new terms.

Returns

A glossary.

Body
Glossary

Update glossary category

Replaces the name and description of a glossary category.

Parameters

Name Key Required Type Description
Category ID
categoryId True string

The category id.

Glossary ID
glossaryId True string

The glossary id.

Name
name string

The name of the category.

Parent ID
parentId string

The parent id.

Stewards
stewards array of string

This list contains the UIDs of the stewards of the category.

Description
description string

The description.

Returns

A glossary category.

Update glossary term

Replaces the definition and attributes of a glossary term.

Parameters

Name Key Required Type Description
Glossary ID
glossaryId True string

The glossary id.

Term ID
termId True string

The term id.

Name
name True string

The name.

Tags
tags array of string

The tags.

Type
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.

Resource ID
resourceId True string

The unique identifier of the resource (app or dataset) to link to the term.

Resource Type
resourceType True string

The type of resource being linked to the term.

Sub Resource ID
subResourceId string

Required when subResourceType or subResourceName is provided.

Sub Resource Name
subResourceName string

Required when subResourceType or subResourceId is provided.

Sub Resource Type
subResourceType string

Required when subResourceId or subResourceName is provided.

Stewards
stewards array of string

This list contain the UIDs for the term's stewards.

Type
type True string

How the term related to the other object.

Term ID
termId True string

The unique identifier of the related term.

Categories
categories array of string

Category Ids that the term belongs to.

Description
description string

The description.

Abbreviation
abbreviation string

The abbreviation.

Related Information
relatedInformation string

Related information for the term.

Returns

A glossary term.

Definitions

Connection

The connection between ancoreMate and Qlik Cloud.

Name Path Type Description
Connected
connected boolean

Whether ancoreMate is connected to Qlik Cloud.

Qlik Cloud tenant
tenantHost string

The host name of the connected Qlik Cloud tenant.

Qlik user
qlikUserName string

The name of the connected Qlik Cloud user.

Connected at
connectedAt date-time

The time the connection was established.

DataAsset

A data asset.

Name Path Type Description
ID
id string

Only required when updating the resource.

Name
name string

The name.

Tags
tags array of string

The tags.

App ID
appId string

The app id.

App Type
appType string

The app type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Tenant ID
tenantId string

The value is automatically set by the application.

Created By
createdBy string

The value is automatically set by the application.

Properties
properties object

A Map of name-value pairs.

Created Time
createdTime date-time

The value is automatically set by the application.

Description
description string

The description.

Data Freshness
dataFreshness date-time

The date-time when the source data was last changed.

ID
dataStoreInfo.id string

The id.

Name
dataStoreInfo.name string

The name.

Type
dataStoreInfo.type string

The type.

Technical Name
technicalName string

The technical name.

Last Modified By
lastModifiedBy string

The value is automatically set by the application.

Last Modified Time
lastModifiedTime date-time

The value is automatically set by the application.

Technical Description
technicalDescription string

The technical description.

DataAssetList

A list of data asset items.

Name Path Type Description
Items
value array of DataAsset

The items.

DataStore

A data store.

Name Path Type Description
ID
id string

Only required when updating the resource.

URI
uri string

The uri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type string

The type.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Tenant ID
tenantId string

The value is automatically set by the application.

Created By
createdBy string

The value is automatically set by the application.

Properties
properties object

A Map of name-value pairs.

Created Time
createdTime date-time

The value is automatically set by the application.

Description
description string

The description.

Technical Name
technicalName string

The technical name.

Last Modified By
lastModifiedBy string

The value is automatically set by the application.

Last Modified Time
lastModifiedTime date-time

The value is automatically set by the application.

Technical Description
technicalDescription string

The technical description.

DataStoreList

A list of data store items.

Name Path Type Description
Items
value array of DataStore

The items.

Dataset

A dataset.

Name Path Type Description
ID
id string

Only required when updating the resource.

QRI
qri string

NOTE: this will be deprecated after migration to secureQri.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
type string

The type.

Anomalies
schema.anomalies array of string

Anomalies associated with this schema.

Data Fields
schema.dataFields array of object

The data fields.

Name
schema.dataFields.name string

The name.

Tags
schema.dataFields.tags array of object

An array of system tags.

items
schema.dataFields.tags object

An item.

Alias
schema.dataFields.alias string

Alias of the field.

Index
schema.dataFields.index integer

The index.

Orphan
schema.dataFields.orphan boolean

The orphan.

Data Type
schema.dataFields.dataType object

The data type.

Nullable
schema.dataFields.nullable boolean

The nullable.

User Tags
schema.dataFields.userTags array of object

An array of user-supplied tags.

items
schema.dataFields.userTags object

An item.

Encrypted
schema.dataFields.encrypted boolean

The encrypted.

Sensitive
schema.dataFields.sensitive boolean

The sensitive.

Primary Key
schema.dataFields.primaryKey boolean

The primary key.

Properties
schema.dataFields.properties object

The properties.

Description
schema.dataFields.description string

The description.

Ordinal Position In Key
schema.dataFields.ordinalPositionInKey integer

The ordinal position in key.

Schema Name
schema.schemaName string

The schema name.

Load Options
schema.loadOptions object

Options for loading files.

Effective Date
schema.effectiveDate date-time

The effective date.

Override Schema Anomalies
schema.overrideSchemaAnomalies boolean

The override schema anomalies.

Owner ID
ownerId string

The value is automatically set by the application.

Space ID
spaceId string

The space id.

Version
version integer

Only required when updating the resource.

Tenant ID
tenantId string

The value is automatically set by the application.

Created By
createdBy string

The value is automatically set by the application.

Secure QRI
secureQri string

The secure qri.

Properties
properties object

A Map of name-value pairs.

Created Time
createdTime date-time

The value is automatically set by the application.

Description
description string

The description.

Size
operational.size integer

The size.

Status
operational.status string

The status.

End Date
operational.endDate date-time

The end date.

Location
operational.location string

The location.

Row Count
operational.rowCount integer

The row count.

Start Date
operational.startDate date-time

The start date.

Log Message
operational.logMessage string

The log message.

Table Owner
operational.tableOwner string

The table owner.

Last Load Time
operational.lastLoadTime date-time

The last load time.

Content Updated
operational.contentUpdated boolean

The content updated.

Last Update Time
operational.lastUpdateTime date-time

The last update time.

Table Name
operational.tableConnectionInfo.tableName string

The table name.

Selection Script
operational.tableConnectionInfo.selectionScript string

The selection script.

Additional Properties
operational.tableConnectionInfo.additionalProperties object

The additional properties.

ID
dataAssetInfo.id string

The id.

Name
dataAssetInfo.name string

The name.

ID
dataAssetInfo.dataStoreInfo.id string

The id.

Name
dataAssetInfo.dataStoreInfo.name string

The name.

Type
dataAssetInfo.dataStoreInfo.type string

The type.

Technical Name
technicalName string

The technical name.

Last Modified By
lastModifiedBy string

The value is automatically set by the application.

App Type Override
appTypeOverride string

Optional override of DataAsset appType.

Last Modified Time
lastModifiedTime date-time

The value is automatically set by the application.

Additional Schemas
additionalSchemas array of object

Optional field to specify additional schemas for files where multiple tables or sheets are available.

Anomalies
additionalSchemas.anomalies array of string

Anomalies associated with this schema.

Data Fields
additionalSchemas.dataFields array of object

The data fields.

items
additionalSchemas.dataFields object

An item.

Schema Name
additionalSchemas.schemaName string

The schema name.

Load Options
additionalSchemas.loadOptions object

Options for loading files.

Effective Date
additionalSchemas.effectiveDate date-time

The effective date.

Override Schema Anomalies
additionalSchemas.overrideSchemaAnomalies boolean

The override schema anomalies.

Technical Description
technicalDescription string

The technical description.

Created By Connection ID
createdByConnectionId string

The connectionId that created the Dataset.

DatasetList

A list of dataset items.

Name Path Type Description
Items
value array of Dataset

The items.

ExportGlossaryResponse

The result of export glossary.

Name Path Type Description
ID
id string

The id.

Name
name string

The name.

Tags
tags array of string

The tags.

Terms
terms array of object

The terms.

ID
terms.id string

The id of the term.

Name
terms.name string

The name.

Tags
terms.tags array of string

The tags.

Owner
terms.owner array of object

The owner.

items
terms.owner object

An item.

Links To
terms.linksTo array of object

The links to.

items
terms.linksTo object

Describes links to other data assets such as analytics applications or dataset.

Stewards
terms.stewards array of object

The stewards.

items
terms.stewards object

An item.

Relates To
terms.relatesTo array of object

The relates to.

items
terms.relatesTo object

An item.

Categories
terms.categories array of string

Categories that the term belongs to.

Description
terms.description string

The description.

Abbreviation
terms.abbreviation string

The abbreviation.

Steward Details
terms.stewardDetails array of object

The steward details.

items
terms.stewardDetails object

An item.

Owner ID
ownerId string

The owner id.

Space ID
spaceId string

The space id.

Overview
overview string

Overview of the glossary.

Created At
createdAt date-time

The created at.

Created By
createdBy string

The created by.

Updated At
updatedAt date-time

The updated at.

Updated By
updatedBy string

The uid of the user who last updated the glossary.

Categories
categories array of object

The categories.

ID
categories.id string

The id for resolving updates in future imports/updates.

Name
categories.name string

The name of the category.

Parent ID
categories.parentId string

The parent id.

Description
categories.description string

The description.

Steward Details
categories.stewardDetails array of object

The steward details.

items
categories.stewardDetails object

An item.

Description
description string

The description.

Related Information
termTemplate.relatedInformation string

Template text for new terms.

Glossary

A glossary.

Name Path Type Description
ID
id string

Unique identifier of the glossary.

Name
name string

Name of the glossary.

Tags
tags array of string

List of tags associated with the glossary.

Owner ID
ownerId string

The unique identifier of the glossary owner.

Space ID
spaceId string

The unique identifier of the space containing the glossary.

Overview
overview string

Overview of the glossary contents.

Created At
createdAt date-time

Datetime when the glossary was created.

Created By
createdBy string

Unique identifier of the user who created the glossary.

Updated At
updatedAt date-time

Datetime when the glossary was updated.

Updated By
updatedBy string

The unique identifier of the user who last updated the glossary.

Description
description string

Description of the glossary.

Related Information
termTemplate.relatedInformation string

Template text for new terms.

GlossaryCategory

A glossary category.

Name Path Type Description
ID
id string

The id for resolving updates in future imports/updates.

Name
name string

The name.

Parent ID
parentId string

The parent id.

Stewards
stewards array of string

This list contains the UIDs of the stewards of the category.

Created At
createdAt date-time

The created at.

Created By
createdBy string

The created by.

Updated At
updatedAt date-time

The updated at.

Updated By
updatedBy string

The uid of the user who last updated the category.

Glossary ID
glossaryId string

The glossary id.

Description
description string

The description.

GlossaryCategoryList

A list of glossary category items.

Name Path Type Description
Items
value array of GlossaryCategory

The items.

GlossaryList

A list of glossary items.

Name Path Type Description
Items
value array of Glossary

The items.

GlossaryTerm

A glossary term.

Name Path Type Description
ID
id string

The id.

Name
name string

The name.

Tags
tags array of string

The tags.

Type
status.type string

The type.

Updated At
status.updatedAt date-time

Time when the state was changed.

Updated By
status.updatedBy string

The unique identifier of the user who last changed the status of the term.

Links To
linksTo array of object

The links to.

ID
linksTo.id string

The id.

Name
linksTo.name string

The name.

Type
linksTo.type string

The type.

Title
linksTo.title string

Describes reason for item status during batch operation.

Status
linksTo.status number

Http status code for item during batch operation.

Open URL
linksTo.openUrl string

The open url.

Created At
linksTo.createdAt date-time

The created at.

Created By
linksTo.createdBy string

The created by.

Resource ID
linksTo.resourceId string

Different formats based on resource type.

Resource Type
linksTo.resourceType string

The resource type.

Sub Resource ID
linksTo.subResourceId string

Different formats based on subresource type.

Resource Space ID
linksTo.resourceSpaceId string

The resource space id.

Sub Resource Name
linksTo.subResourceName string

The sub resource name.

Sub Resource Type
linksTo.subResourceType string

The sub resource type.

Sub Resource Invalid
linksTo.subResourceInvalid boolean

Populated and true if no matching subresource is found on parent resource.

Revision
revision number

The revision.

Stewards
stewards array of string

This list contains the UIDs of the terms data stewards.

Created At
createdAt date-time

The created at.

Created By
createdBy string

The created by.

Relates To
relatesTo array of object

Term relations assigned to this term.

Type
relatesTo.type string

How the term related to the other object.

Term ID
relatesTo.termId string

The unique identifier of the related term.

Updated At
updatedAt date-time

The updated at.

Updated By
updatedBy string

The uid of the user who last updated the term.

Categories
categories array of string

The categories.

Glossary ID
glossaryId string

The glossary id.

Description
description string

The description.

Abbreviation
abbreviation string

The abbreviation.

Referred Relations
referredRelations array of object

Term relations where this term is the target of the relation.

Type
referredRelations.type string

How the term related to the other object.

Term ID
referredRelations.termId string

The unique identifier of the related term.

Related Information
relatedInformation string

Related information for the term.

GlossaryTermList

A list of glossary term items.

Name Path Type Description
Items
value array of GlossaryTerm

The items.

object

This is the type 'object'.