Skip to main content

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.

In n8n, these actions are in the node ancoreMate. Each action below names its n8n resource and operation.

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

Good to know​

  • Creating and changing glossaries needs a Qlik Cloud user with the permission to manage glossaries, for example the Steward role.

Overview​

ActionGroupDescription
Create data assetData assetCreates a data asset in a data store.
Delete data assetData assetDeletes a data asset.
Get data assetData assetReturns a data asset.
List data assetsData assetLists the data assets of a data store.
Update data assetData assetReplaces the attributes of a data asset.
Create data storeData storeCreates a data store in the catalog.
Get data storeData storeReturns a data store.
List data storesData storeLists the data stores of the catalog.
Update data storeData storeReplaces the attributes of a data store.
Create datasetDatasetCreates a dataset in a data asset.
Delete datasetDatasetDeletes a dataset.
Get datasetDatasetReturns a dataset with its schema.
List datasetsDatasetLists the datasets of a data asset.
Update datasetDatasetReplaces the attributes of a dataset.
Create glossaryGlossaryCreates a business glossary.
Delete glossaryGlossaryDeletes a glossary with its categories and terms.
Export glossaryGlossaryExports a glossary with its categories and terms as JSON.
Get glossaryGlossaryReturns a business glossary.
Import glossaryGlossaryCreates a glossary from an exported glossary.
List glossariesGlossaryLists the business glossaries.
Update glossaryGlossaryReplaces the name, description and settings of a glossary.
Create glossary categoryGlossary categoryCreates a category in a glossary.
Delete glossary categoryGlossary categoryDeletes a category of a glossary.
Get glossary categoryGlossary categoryReturns a category of a glossary.
List glossary categoriesGlossary categoryLists the categories of a glossary.
Update glossary categoryGlossary categoryReplaces the name and description of a glossary category.
Change glossary term statusGlossary termSets the status of a glossary term, for example verified.
Create glossary termGlossary termCreates a term in a glossary.
Delete glossary termGlossary termDeletes a term of a glossary.
Get glossary termGlossary termReturns a term of a glossary.
List glossary termsGlossary termLists the terms of a glossary.
Update glossary termGlossary termReplaces the definition and attributes of a glossary term.

Every connector also has the actions Get Qlik connection and Send Qlik Cloud request. Errors that all actions share: Standard errors.

Data asset​

Create data asset​

Creates a data asset in a data store.

n8nresource Data asset → operation Create
InputTypeDescription
IDtextOnly required when updating the resource.
NametextThe name.
TagslistThe tags.
App IDtextThe app id.
App Type requiredtextThe app type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
Data Freshnessdate and timeThe date-time when the source data was last changed.
Data Store InfoobjectThe data store info. Contains: ID.
Technical Name requiredtextThe technical name.
Technical DescriptiontextThe technical description.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
NametextThe name.
TagslistThe tags.
App IDtextThe app id.
App TypetextThe app type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Data Freshnessdate and timeThe date-time when the source data was last changed.
Data Store InfoobjectThe data store info. Contains: ID, Name, Type.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

Delete data asset​

Deletes a data asset.

n8nresource Data asset → operation Delete
InputTypeDescription
Data asset ID requiredtextThe ID of the data asset.

Result: The action was completed.

Get data asset​

Returns a data asset.

n8nresource Data asset → operation Get
InputTypeDescription
Data Asset ID requiredtextThe data asset id.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
NametextThe name.
TagslistThe tags.
App IDtextThe app id.
App TypetextThe app type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Data Freshnessdate and timeThe date-time when the source data was last changed.
Data Store InfoobjectThe data store info. Contains: ID, Name, Type.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

List data assets​

Lists the data assets of a data store.

n8nresource Data asset → operation Get Many
InputTypeDescription
Data Store ID requiredchoiceComma-separated data store IDs or * to include all data stores.
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, Name, Tags, App ID, App Type, Owner ID, Space ID, Version, Tenant ID, Created By, Properties, Created Time, Description, Data Freshness, Data Store Info, Technical Name, Last Modified By, Last Modified Time, Technical Description.

Update data asset​

Replaces the attributes of a data asset.

n8nresource Data asset → operation Update
InputTypeDescription
Data Asset ID requiredtextThe data asset id.
IDtextOnly required when updating the resource.
NametextThe name.
TagslistThe tags.
App IDtextThe app id.
App Type requiredtextThe app type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
Data Freshnessdate and timeThe date-time when the source data was last changed.
Data Store InfoobjectThe data store info. Contains: ID.
Technical Name requiredtextThe technical name.
Technical DescriptiontextThe technical description.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
NametextThe name.
TagslistThe tags.
App IDtextThe app id.
App TypetextThe app type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Data Freshnessdate and timeThe date-time when the source data was last changed.
Data Store InfoobjectThe data store info. Contains: ID, Name, Type.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

Data store​

Create data store​

Creates a data store in the catalog.

n8nresource Data store → operation Create
InputTypeDescription
IDtextOnly required when updating the resource.
URItextThe uri.
NametextThe name.
TagslistThe tags.
Type requiredtextThe type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
Technical Name requiredtextThe technical name.
Technical DescriptiontextThe technical description.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
URItextThe uri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

Get data store​

Returns a data store.

n8nresource Data store → operation Get
InputTypeDescription
Data Store ID requiredchoiceThe data store id.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
URItextThe uri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

List data stores​

Lists the data stores of the catalog.

n8nresource Data store → operation Get Many
InputTypeDescription
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, URI, Name, Tags, Type, Owner ID, Space ID, Version, Tenant ID, Created By, Properties, Created Time, Description, Technical Name, Last Modified By, Last Modified Time, Technical Description.

Update data store​

Replaces the attributes of a data store.

n8nresource Data store → operation Update
InputTypeDescription
Data Store ID requiredchoiceThe data store id.
IDtextOnly required when updating the resource.
URItextThe uri.
NametextThe name.
TagslistThe tags.
Type requiredtextThe type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
Technical Name requiredtextThe technical name.
Technical DescriptiontextThe technical description.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
URItextThe uri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
Last Modified Timedate and timeThe value is automatically set by the application.
Technical DescriptiontextThe technical description.

Dataset​

Create dataset​

Creates a dataset in a data asset.

n8nresource Dataset → operation Create
InputTypeDescription
IDtextOnly required when updating the resource.
QRI requiredtextNOTE: this will be deprecated after migration to secureQri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
SchemaobjectOptional field to specify additional schemas for files where multiple tables or sheets are available. Contains: Anomalies, Data Fields, Schema Name, Load Options, Override Schema Anomalies.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Secure QRI requiredtextThe secure qri.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
OperationalobjectThe operational. Contains: Size, Status, End Date, Location, Row Count, Start Date, Log Message, Table Owner, Last Load Time, Content Updated, Last Update Time, Table Connection Info.
Data Asset Info requiredobjectThe data asset info. Contains: ID, Data Store Info.
Technical Name requiredtextThe technical name.
App Type OverridetextOptional override of DataAsset appType.
Additional SchemaslistOptional field to specify additional schemas for files where multiple tables or sheets are available. Each entry has: Anomalies, Data Fields, Schema Name, Load Options, Override Schema Anomalies.
Technical DescriptiontextThe technical description.
Created By Connection IDtextThe connectionId that created the Dataset.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
QRItextNOTE: this will be deprecated after migration to secureQri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
SchemaobjectOptional field to specify additional schemas for files where multiple tables or sheets are available. Contains: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
Secure QRItextThe secure qri.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
OperationalobjectThe operational. Contains: Size, Status, End Date, Location, Row Count, Start Date, Log Message, Table Owner, Last Load Time, Content Updated, Last Update Time, Table Connection Info.
Data Asset InfoobjectThe data asset info. Contains: ID, Name, Data Store Info.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
App Type OverridetextOptional override of DataAsset appType.
Last Modified Timedate and timeThe value is automatically set by the application.
Additional SchemaslistOptional field to specify additional schemas for files where multiple tables or sheets are available. Each entry has: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Technical DescriptiontextThe technical description.
Created By Connection IDtextThe connectionId that created the Dataset.

Delete dataset​

Deletes a dataset.

n8nresource Dataset → operation Delete
InputTypeDescription
Dataset ID requiredtextThe ID of the dataset.

Result: The action was completed.

Get dataset​

Returns a dataset with its schema.

n8nresource Dataset → operation Get
InputTypeDescription
Dataset ID requiredtextThe dataset id.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
QRItextNOTE: this will be deprecated after migration to secureQri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
SchemaobjectOptional field to specify additional schemas for files where multiple tables or sheets are available. Contains: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
Secure QRItextThe secure qri.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
OperationalobjectThe operational. Contains: Size, Status, End Date, Location, Row Count, Start Date, Log Message, Table Owner, Last Load Time, Content Updated, Last Update Time, Table Connection Info.
Data Asset InfoobjectThe data asset info. Contains: ID, Name, Data Store Info.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
App Type OverridetextOptional override of DataAsset appType.
Last Modified Timedate and timeThe value is automatically set by the application.
Additional SchemaslistOptional field to specify additional schemas for files where multiple tables or sheets are available. Each entry has: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Technical DescriptiontextThe technical description.
Created By Connection IDtextThe connectionId that created the Dataset.

List datasets​

Lists the datasets of a data asset.

n8nresource Dataset → operation Get Many
InputTypeDescription
Data Asset ID requiredtextComma-separated data asset IDs or * to include all data assets.
Data Store ID requiredchoiceComma-separated data store IDs or * to include all data stores.
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, QRI, Name, Tags, Type, Schema, Owner ID, Space ID, Version, Tenant ID, Created By, Secure QRI, Properties, Created Time, Description, Operational, Data Asset Info, Technical Name, Last Modified By, App Type Override, Last Modified Time, Additional Schemas, Technical Description, Created By Connection ID.

Update dataset​

Replaces the attributes of a dataset.

n8nresource Dataset → operation Update
InputTypeDescription
Dataset ID requiredtextThe dataset id.
IDtextOnly required when updating the resource.
QRI requiredtextNOTE: this will be deprecated after migration to secureQri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
SchemaobjectOptional field to specify additional schemas for files where multiple tables or sheets are available. Contains: Anomalies, Data Fields, Schema Name, Load Options, Override Schema Anomalies.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Secure QRI requiredtextThe secure qri.
PropertiesobjectA Map of name-value pairs.
DescriptiontextThe description.
OperationalobjectThe operational. Contains: Size, Status, End Date, Location, Row Count, Start Date, Log Message, Table Owner, Last Load Time, Content Updated, Last Update Time, Table Connection Info.
Data Asset Info requiredobjectThe data asset info. Contains: ID, Data Store Info.
Technical Name requiredtextThe technical name.
App Type OverridetextOptional override of DataAsset appType.
Additional SchemaslistOptional field to specify additional schemas for files where multiple tables or sheets are available. Each entry has: Anomalies, Data Fields, Schema Name, Load Options, Override Schema Anomalies.
Technical DescriptiontextThe technical description.
Created By Connection IDtextThe connectionId that created the Dataset.

Result: The result of the action.

FieldTypeDescription
IDtextOnly required when updating the resource.
QRItextNOTE: this will be deprecated after migration to secureQri.
NametextThe name.
TagslistThe tags.
TypetextThe type.
SchemaobjectOptional field to specify additional schemas for files where multiple tables or sheets are available. Contains: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Owner IDtextThe value is automatically set by the application.
Space IDtextThe space id.
VersionnumberOnly required when updating the resource.
Tenant IDtextThe value is automatically set by the application.
Created BytextThe value is automatically set by the application.
Secure QRItextThe secure qri.
PropertiesobjectA Map of name-value pairs.
Created Timedate and timeThe value is automatically set by the application.
DescriptiontextThe description.
OperationalobjectThe operational. Contains: Size, Status, End Date, Location, Row Count, Start Date, Log Message, Table Owner, Last Load Time, Content Updated, Last Update Time, Table Connection Info.
Data Asset InfoobjectThe data asset info. Contains: ID, Name, Data Store Info.
Technical NametextThe technical name.
Last Modified BytextThe value is automatically set by the application.
App Type OverridetextOptional override of DataAsset appType.
Last Modified Timedate and timeThe value is automatically set by the application.
Additional SchemaslistOptional field to specify additional schemas for files where multiple tables or sheets are available. Each entry has: Anomalies, Data Fields, Schema Name, Load Options, Effective Date, Override Schema Anomalies.
Technical DescriptiontextThe technical description.
Created By Connection IDtextThe connectionId that created the Dataset.

Glossary​

Create glossary​

Creates a business glossary.

n8nresource Glossary → operation Create
InputTypeDescription
Name requiredtextName of the glossary.
TagslistList of tags for glossary.
Space IDtextUnique unique identifier of the space to contain the glossary.
OverviewtextOverview of the glossary content.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

Result: The result of the action.

FieldTypeDescription
IDtextUnique identifier of the glossary.
NametextName of the glossary.
TagslistList of tags associated with the glossary.
Owner IDtextThe unique identifier of the glossary owner.
Space IDtextThe unique identifier of the space containing the glossary.
OverviewtextOverview of the glossary contents.
Created Atdate and timeDatetime when the glossary was created.
Created BytextUnique identifier of the user who created the glossary.
Updated Atdate and timeDatetime when the glossary was updated.
Updated BytextThe unique identifier of the user who last updated the glossary.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

Delete glossary​

Deletes a glossary with its categories and terms.

n8nresource Glossary → operation Delete
InputTypeDescription
Glossary ID requiredchoiceThe id of the glossary to delete.

Result: The action was completed.

Export glossary​

Exports a glossary with its categories and terms as JSON.

n8nresource Glossary → operation Export
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.

Result: The result of the action.

FieldTypeDescription
IDtextThe id.
NametextThe name.
TagslistThe tags.
TermslistThe terms. Each entry has: ID, Name, Tags, Owner, Links To, Stewards, Relates To, Categories, Description, Abbreviation, Steward Details.
Owner IDtextThe owner id.
Space IDtextThe space id.
OverviewtextOverview of the glossary.
Created Atdate and timeThe created at.
Created BytextThe created by.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the glossary.
CategorieslistThe categories. Each entry has: ID, Name, Parent ID, Description, Steward Details.
DescriptiontextThe description.
Term TemplateobjectThe term template. Contains: Related Information.

Get glossary​

Returns a business glossary.

n8nresource Glossary → operation Get
InputTypeDescription
Glossary ID requiredchoiceThe id of the glossary to retrieve.

Result: The result of the action.

FieldTypeDescription
IDtextUnique identifier of the glossary.
NametextName of the glossary.
TagslistList of tags associated with the glossary.
Owner IDtextThe unique identifier of the glossary owner.
Space IDtextThe unique identifier of the space containing the glossary.
OverviewtextOverview of the glossary contents.
Created Atdate and timeDatetime when the glossary was created.
Created BytextUnique identifier of the user who created the glossary.
Updated Atdate and timeDatetime when the glossary was updated.
Updated BytextThe unique identifier of the user who last updated the glossary.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

Import glossary​

Creates a glossary from an exported glossary.

n8nresource Glossary → operation Import
InputTypeDescription
Importer As Fallback Stewardyes/noAppending the current importer user as steward to categories/terms where no steward is defined/not match the identity service.
Lookup User On Emailyes/noUsing email in the steward fields to lookup userIds in the identity service.
Space IDtextThe spaceId (leave blank or omit for personal).
NametextThe name.
TagslistThe tags.
TermslistThe terms. Each entry has: ID, Name, Tags, Owner, Links To, Stewards, Relates To, Categories, Description, Abbreviation, Steward Details.
Space IDtextThe space id.
OverviewtextOverview of the glossary.
CategorieslistThe categories. Each entry has: ID, Name, Parent ID, Stewards, Description, Steward Details.
DescriptiontextThe description.
Term TemplateobjectThe term template. Contains: Related Information.

Result: The result of the action.

FieldTypeDescription
IDtextUnique identifier of the glossary.
NametextName of the glossary.
TagslistList of tags associated with the glossary.
Owner IDtextThe unique identifier of the glossary owner.
Space IDtextThe unique identifier of the space containing the glossary.
OverviewtextOverview of the glossary contents.
Created Atdate and timeDatetime when the glossary was created.
Created BytextUnique identifier of the user who created the glossary.
Updated Atdate and timeDatetime when the glossary was updated.
Updated BytextThe unique identifier of the user who last updated the glossary.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

List glossaries​

Lists the business glossaries.

n8nresource Glossary → operation Get Many
InputTypeDescription
SortchoiceOptional resource field name to sort on, eg. Choices: name, +name, -name, description, +description, -description.
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, Name, Tags, Owner ID, Space ID, Overview, Created At, Created By, Updated At, Updated By, Description, Term Template.

Update glossary​

Replaces the name, description and settings of a glossary.

n8nresource Glossary → operation Update
InputTypeDescription
Glossary ID requiredchoiceThe id of the glossary to update.
Name requiredtextName of the glossary.
TagslistList of tags for glossary.
Space IDtextUnique unique identifier of the space to contain the glossary.
OverviewtextOverview of the glossary content.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

Result: The result of the action.

FieldTypeDescription
IDtextUnique identifier of the glossary.
NametextName of the glossary.
TagslistList of tags associated with the glossary.
Owner IDtextThe unique identifier of the glossary owner.
Space IDtextThe unique identifier of the space containing the glossary.
OverviewtextOverview of the glossary contents.
Created Atdate and timeDatetime when the glossary was created.
Created BytextUnique identifier of the user who created the glossary.
Updated Atdate and timeDatetime when the glossary was updated.
Updated BytextThe unique identifier of the user who last updated the glossary.
DescriptiontextDescription of the glossary.
Term TemplateobjectThe term template. Contains: Related Information.

Glossary category​

Create glossary category​

Creates a category in a glossary.

n8nresource Glossary category → operation Create
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
NametextThe name of the category.
Parent IDtextThe parent id.
StewardslistThis list contains the UIDs of the stewards of the category.
DescriptiontextThe description.

Result: The result of the action.

FieldTypeDescription
IDtextThe id for resolving updates in future imports/updates.
NametextThe name.
Parent IDtextThe parent id.
StewardslistThis list contains the UIDs of the stewards of the category.
Created Atdate and timeThe created at.
Created BytextThe created by.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the category.
Glossary IDtextThe glossary id.
DescriptiontextThe description.

Delete glossary category​

Deletes a category of a glossary.

n8nresource Glossary category → operation Delete
InputTypeDescription
Category ID requiredtextThe id for the category to delete.
Glossary ID requiredchoiceThe id of the glossary.

Result: The action was completed.

Get glossary category​

Returns a category of a glossary.

n8nresource Glossary category → operation Get
InputTypeDescription
Category ID requiredtextThe category id.
Glossary ID requiredchoiceThe glossary id.

Result: The result of the action.

FieldTypeDescription
IDtextThe id for resolving updates in future imports/updates.
NametextThe name.
Parent IDtextThe parent id.
StewardslistThis list contains the UIDs of the stewards of the category.
Created Atdate and timeThe created at.
Created BytextThe created by.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the category.
Glossary IDtextThe glossary id.
DescriptiontextThe description.

List glossary categories​

Lists the categories of a glossary.

n8nresource Glossary category → operation Get Many
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
SortchoiceOptional resource field name to sort on, eg. Choices: description, +description, -description, name, +name, -name, update, +update, -update.
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, Name, Parent ID, Stewards, Created At, Created By, Updated At, Updated By, Glossary ID, Description.

Update glossary category​

Replaces the name and description of a glossary category.

n8nresource Glossary category → operation Update
InputTypeDescription
Category ID requiredtextThe category id.
Glossary ID requiredchoiceThe glossary id.
NametextThe name of the category.
Parent IDtextThe parent id.
StewardslistThis list contains the UIDs of the stewards of the category.
DescriptiontextThe description.

Result: The result of the action.

FieldTypeDescription
IDtextThe id for resolving updates in future imports/updates.
NametextThe name.
Parent IDtextThe parent id.
StewardslistThis list contains the UIDs of the stewards of the category.
Created Atdate and timeThe created at.
Created BytextThe created by.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the category.
Glossary IDtextThe glossary id.
DescriptiontextThe description.

Glossary term​

Change glossary term status​

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

n8nresource Glossary term → operation Change Status
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
Term ID requiredtextThe term id.
Status requiredchoiceThe status to update to. Choices: draft, verified, deprecated.

Result: The result of the action.

FieldTypeDescription
IDtextThe id.
NametextThe name.
TagslistThe tags.
StatusobjectTerms status is used determine the status of a term. Contains: Type, Updated At, Updated By.
Links TolistThe links to. Each entry has: ID, Name, Type, Title, Status, Open URL, Created At, Created By, Resource ID, Resource Type, Sub Resource ID, Resource Space ID, Sub Resource Name, Sub Resource Type, Sub Resource Invalid.
RevisionnumberThe revision.
StewardslistThis list contains the UIDs of the terms data stewards.
Created Atdate and timeThe created at.
Created BytextThe created by.
Relates TolistTerm relations assigned to this term. Each entry has: Type, Term ID.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the term.
CategorieslistThe categories.
Glossary IDtextThe glossary id.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Referred RelationslistTerm relations where this term is the target of the relation. Each entry has: Type, Term ID.
Related InformationtextRelated information for the term.

Create glossary term​

Creates a term in a glossary.

n8nresource Glossary term → operation Create
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
Name requiredtextThe name.
TagslistThe tags.
Links TolistThe links to. Each entry has: Type, Resource ID, Resource Type, Sub Resource ID, Sub Resource Name, Sub Resource Type.
StewardslistThis list contain the UIDs for the term's stewards.
Relates TolistThe relates to. Each entry has: Type, Term ID.
CategorieslistCategory Ids that the term belongs to.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Related InformationtextRelated information for the term.

Result: The result of the action.

FieldTypeDescription
IDtextThe id.
NametextThe name.
TagslistThe tags.
StatusobjectTerms status is used determine the status of a term. Contains: Type, Updated At, Updated By.
Links TolistThe links to. Each entry has: ID, Name, Type, Title, Status, Open URL, Created At, Created By, Resource ID, Resource Type, Sub Resource ID, Resource Space ID, Sub Resource Name, Sub Resource Type, Sub Resource Invalid.
RevisionnumberThe revision.
StewardslistThis list contains the UIDs of the terms data stewards.
Created Atdate and timeThe created at.
Created BytextThe created by.
Relates TolistTerm relations assigned to this term. Each entry has: Type, Term ID.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the term.
CategorieslistThe categories.
Glossary IDtextThe glossary id.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Referred RelationslistTerm relations where this term is the target of the relation. Each entry has: Type, Term ID.
Related InformationtextRelated information for the term.

Delete glossary term​

Deletes a term of a glossary.

n8nresource Glossary term → operation Delete
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
Term ID requiredtextThe term id.

Result: The action was completed.

Get glossary term​

Returns a term of a glossary.

n8nresource Glossary term → operation Get
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
Term ID requiredtextThe term id.

Result: The result of the action.

FieldTypeDescription
IDtextThe id.
NametextThe name.
TagslistThe tags.
StatusobjectTerms status is used determine the status of a term. Contains: Type, Updated At, Updated By.
Links TolistThe links to. Each entry has: ID, Name, Type, Title, Status, Open URL, Created At, Created By, Resource ID, Resource Type, Sub Resource ID, Resource Space ID, Sub Resource Name, Sub Resource Type, Sub Resource Invalid.
RevisionnumberThe revision.
StewardslistThis list contains the UIDs of the terms data stewards.
Created Atdate and timeThe created at.
Created BytextThe created by.
Relates TolistTerm relations assigned to this term. Each entry has: Type, Term ID.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the term.
CategorieslistThe categories.
Glossary IDtextThe glossary id.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Referred RelationslistTerm relations where this term is the target of the relation. Each entry has: Type, Term ID.
Related InformationtextRelated information for the term.

List glossary terms​

Lists the terms of a glossary.

n8nresource Glossary term → operation Get Many
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
FiltertextOptional SCIM filter to be used to filter terms Usable fields are - id - name - relatedInformation - description - abbreviation - tags - stewards - status - categories.
SortchoiceOptional resource field name to sort on, eg. Choices: abbreviation, +abbreviation, -abbreviation, description, +description, -description, name, +name, -name, status, +status, -status, updated, +updated, -updated.
LimitnumberThe maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000.

Result: The result of the action.

FieldTypeDescription
ItemslistThe items. Each entry has: ID, Name, Tags, Status, Links To, Revision, Stewards, Created At, Created By, Relates To, Updated At, Updated By, Categories, Glossary ID, Description, Abbreviation, Referred Relations, Related Information.

Update glossary term​

Replaces the definition and attributes of a glossary term.

n8nresource Glossary term → operation Update
InputTypeDescription
Glossary ID requiredchoiceThe glossary id.
Term ID requiredtextThe term id.
Name requiredtextThe name.
TagslistThe tags.
Links TolistThe links to. Each entry has: Type, Resource ID, Resource Type, Sub Resource ID, Sub Resource Name, Sub Resource Type.
StewardslistThis list contain the UIDs for the term's stewards.
Relates TolistThe relates to. Each entry has: Type, Term ID.
CategorieslistCategory Ids that the term belongs to.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Related InformationtextRelated information for the term.

Result: The result of the action.

FieldTypeDescription
IDtextThe id.
NametextThe name.
TagslistThe tags.
StatusobjectTerms status is used determine the status of a term. Contains: Type, Updated At, Updated By.
Links TolistThe links to. Each entry has: ID, Name, Type, Title, Status, Open URL, Created At, Created By, Resource ID, Resource Type, Sub Resource ID, Resource Space ID, Sub Resource Name, Sub Resource Type, Sub Resource Invalid.
RevisionnumberThe revision.
StewardslistThis list contains the UIDs of the terms data stewards.
Created Atdate and timeThe created at.
Created BytextThe created by.
Relates TolistTerm relations assigned to this term. Each entry has: Type, Term ID.
Updated Atdate and timeThe updated at.
Updated BytextThe uid of the user who last updated the term.
CategorieslistThe categories.
Glossary IDtextThe glossary id.
DescriptiontextThe description.
AbbreviationtextThe abbreviation.
Referred RelationslistTerm relations where this term is the target of the relation. Each entry has: Type, Term ID.
Related InformationtextRelated information for the term.