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
| Action | Group | Description |
|---|---|---|
| Create data asset | Data asset | Creates a data asset in a data store. |
| Delete data asset | Data asset | Deletes a data asset. |
| Get data asset | Data asset | Returns a data asset. |
| List data assets | Data asset | Lists the data assets of a data store. |
| Update data asset | Data asset | Replaces the attributes of a data asset. |
| Create data store | Data store | Creates a data store in the catalog. |
| Get data store | Data store | Returns a data store. |
| List data stores | Data store | Lists the data stores of the catalog. |
| Update data store | Data store | Replaces the attributes of a data store. |
| Create dataset | Dataset | Creates a dataset in a data asset. |
| Delete dataset | Dataset | Deletes a dataset. |
| Get dataset | Dataset | Returns a dataset with its schema. |
| List datasets | Dataset | Lists the datasets of a data asset. |
| Update dataset | Dataset | Replaces the attributes of a dataset. |
| Create glossary | Glossary | Creates a business glossary. |
| Delete glossary | Glossary | Deletes a glossary with its categories and terms. |
| Export glossary | Glossary | Exports a glossary with its categories and terms as JSON. |
| Get glossary | Glossary | Returns a business glossary. |
| Import glossary | Glossary | Creates a glossary from an exported glossary. |
| List glossaries | Glossary | Lists the business glossaries. |
| Update glossary | Glossary | Replaces the name, description and settings of a glossary. |
| Create glossary category | Glossary category | Creates a category in a glossary. |
| Delete glossary category | Glossary category | Deletes a category of a glossary. |
| Get glossary category | Glossary category | Returns a category of a glossary. |
| List glossary categories | Glossary category | Lists the categories of a glossary. |
| Update glossary category | Glossary category | Replaces the name and description of a glossary category. |
| Change glossary term status | Glossary term | Sets the status of a glossary term, for example verified. |
| Create glossary term | Glossary term | Creates a term in a glossary. |
| Delete glossary term | Glossary term | Deletes a term of a glossary. |
| Get glossary term | Glossary term | Returns a term of a glossary. |
| List glossary terms | Glossary term | Lists the terms of a glossary. |
| Update glossary term | Glossary term | Replaces 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.
| Input | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| Name | text | The name. |
| Tags | list | The tags. |
| App ID | text | The app id. |
| App Type required | text | The app type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Data Freshness | date and time | The date-time when the source data was last changed. |
| Data Store Info | object | The data store info. Contains: ID. |
| Technical Name required | text | The technical name. |
| Technical Description | text | The technical description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| Name | text | The name. |
| Tags | list | The tags. |
| App ID | text | The app id. |
| App Type | text | The app type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Data Freshness | date and time | The date-time when the source data was last changed. |
| Data Store Info | object | The data store info. Contains: ID, Name, Type. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
Delete data asset
Deletes a data asset.
| Input | Type | Description |
|---|---|---|
| Data asset ID required | text | The ID of the data asset. |
Result: The action was completed.
Get data asset
Returns a data asset.
| Input | Type | Description |
|---|---|---|
| Data Asset ID required | text | The data asset id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| Name | text | The name. |
| Tags | list | The tags. |
| App ID | text | The app id. |
| App Type | text | The app type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Data Freshness | date and time | The date-time when the source data was last changed. |
| Data Store Info | object | The data store info. Contains: ID, Name, Type. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
List data assets
Lists the data assets of a data store.
| Input | Type | Description |
|---|---|---|
| Data Store ID required | choice | Comma-separated data store IDs or * to include all data stores. |
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Data Asset ID required | text | The data asset id. |
| ID | text | Only required when updating the resource. |
| Name | text | The name. |
| Tags | list | The tags. |
| App ID | text | The app id. |
| App Type required | text | The app type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Data Freshness | date and time | The date-time when the source data was last changed. |
| Data Store Info | object | The data store info. Contains: ID. |
| Technical Name required | text | The technical name. |
| Technical Description | text | The technical description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| Name | text | The name. |
| Tags | list | The tags. |
| App ID | text | The app id. |
| App Type | text | The app type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Data Freshness | date and time | The date-time when the source data was last changed. |
| Data Store Info | object | The data store info. Contains: ID, Name, Type. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
Data store
Create data store
Creates a data store in the catalog.
| Input | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| URI | text | The uri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type required | text | The type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Technical Name required | text | The technical name. |
| Technical Description | text | The technical description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| URI | text | The uri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
Get data store
Returns a data store.
| Input | Type | Description |
|---|---|---|
| Data Store ID required | choice | The data store id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| URI | text | The uri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
List data stores
Lists the data stores of the catalog.
| Input | Type | Description |
|---|---|---|
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Data Store ID required | choice | The data store id. |
| ID | text | Only required when updating the resource. |
| URI | text | The uri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type required | text | The type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Technical Name required | text | The technical name. |
| Technical Description | text | The technical description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| URI | text | The uri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Owner ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Technical Description | text | The technical description. |
Dataset
Create dataset
Creates a dataset in a data asset.
| Input | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| QRI required | text | NOTE: this will be deprecated after migration to secureQri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Schema | object | Optional 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 ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Secure QRI required | text | The secure qri. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Operational | object | The 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 required | object | The data asset info. Contains: ID, Data Store Info. |
| Technical Name required | text | The technical name. |
| App Type Override | text | Optional override of DataAsset appType. |
| Additional Schemas | list | Optional 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 Description | text | The technical description. |
| Created By Connection ID | text | The connectionId that created the Dataset. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| QRI | text | NOTE: this will be deprecated after migration to secureQri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Schema | object | Optional 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 ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Secure QRI | text | The secure qri. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Operational | object | The 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 | object | The data asset info. Contains: ID, Name, Data Store Info. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| App Type Override | text | Optional override of DataAsset appType. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Additional Schemas | list | Optional 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 Description | text | The technical description. |
| Created By Connection ID | text | The connectionId that created the Dataset. |
Delete dataset
Deletes a dataset.
| Input | Type | Description |
|---|---|---|
| Dataset ID required | text | The ID of the dataset. |
Result: The action was completed.
Get dataset
Returns a dataset with its schema.
| Input | Type | Description |
|---|---|---|
| Dataset ID required | text | The dataset id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| QRI | text | NOTE: this will be deprecated after migration to secureQri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Schema | object | Optional 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 ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Secure QRI | text | The secure qri. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Operational | object | The 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 | object | The data asset info. Contains: ID, Name, Data Store Info. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| App Type Override | text | Optional override of DataAsset appType. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Additional Schemas | list | Optional 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 Description | text | The technical description. |
| Created By Connection ID | text | The connectionId that created the Dataset. |
List datasets
Lists the datasets of a data asset.
| Input | Type | Description |
|---|---|---|
| Data Asset ID required | text | Comma-separated data asset IDs or * to include all data assets. |
| Data Store ID required | choice | Comma-separated data store IDs or * to include all data stores. |
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Dataset ID required | text | The dataset id. |
| ID | text | Only required when updating the resource. |
| QRI required | text | NOTE: this will be deprecated after migration to secureQri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Schema | object | Optional 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 ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Secure QRI required | text | The secure qri. |
| Properties | object | A Map of name-value pairs. |
| Description | text | The description. |
| Operational | object | The 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 required | object | The data asset info. Contains: ID, Data Store Info. |
| Technical Name required | text | The technical name. |
| App Type Override | text | Optional override of DataAsset appType. |
| Additional Schemas | list | Optional 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 Description | text | The technical description. |
| Created By Connection ID | text | The connectionId that created the Dataset. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Only required when updating the resource. |
| QRI | text | NOTE: this will be deprecated after migration to secureQri. |
| Name | text | The name. |
| Tags | list | The tags. |
| Type | text | The type. |
| Schema | object | Optional 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 ID | text | The value is automatically set by the application. |
| Space ID | text | The space id. |
| Version | number | Only required when updating the resource. |
| Tenant ID | text | The value is automatically set by the application. |
| Created By | text | The value is automatically set by the application. |
| Secure QRI | text | The secure qri. |
| Properties | object | A Map of name-value pairs. |
| Created Time | date and time | The value is automatically set by the application. |
| Description | text | The description. |
| Operational | object | The 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 | object | The data asset info. Contains: ID, Name, Data Store Info. |
| Technical Name | text | The technical name. |
| Last Modified By | text | The value is automatically set by the application. |
| App Type Override | text | Optional override of DataAsset appType. |
| Last Modified Time | date and time | The value is automatically set by the application. |
| Additional Schemas | list | Optional 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 Description | text | The technical description. |
| Created By Connection ID | text | The connectionId that created the Dataset. |
Glossary
Create glossary
Creates a business glossary.
| Input | Type | Description |
|---|---|---|
| Name required | text | Name of the glossary. |
| Tags | list | List of tags for glossary. |
| Space ID | text | Unique unique identifier of the space to contain the glossary. |
| Overview | text | Overview of the glossary content. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Unique identifier of the glossary. |
| Name | text | Name of the glossary. |
| Tags | list | List of tags associated with the glossary. |
| Owner ID | text | The unique identifier of the glossary owner. |
| Space ID | text | The unique identifier of the space containing the glossary. |
| Overview | text | Overview of the glossary contents. |
| Created At | date and time | Datetime when the glossary was created. |
| Created By | text | Unique identifier of the user who created the glossary. |
| Updated At | date and time | Datetime when the glossary was updated. |
| Updated By | text | The unique identifier of the user who last updated the glossary. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
Delete glossary
Deletes a glossary with its categories and terms.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The id of the glossary to delete. |
Result: The action was completed.
Export glossary
Exports a glossary with its categories and terms as JSON.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id. |
| Name | text | The name. |
| Tags | list | The tags. |
| Terms | list | The terms. Each entry has: ID, Name, Tags, Owner, Links To, Stewards, Relates To, Categories, Description, Abbreviation, Steward Details. |
| Owner ID | text | The owner id. |
| Space ID | text | The space id. |
| Overview | text | Overview of the glossary. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the glossary. |
| Categories | list | The categories. Each entry has: ID, Name, Parent ID, Description, Steward Details. |
| Description | text | The description. |
| Term Template | object | The term template. Contains: Related Information. |
Get glossary
Returns a business glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The id of the glossary to retrieve. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Unique identifier of the glossary. |
| Name | text | Name of the glossary. |
| Tags | list | List of tags associated with the glossary. |
| Owner ID | text | The unique identifier of the glossary owner. |
| Space ID | text | The unique identifier of the space containing the glossary. |
| Overview | text | Overview of the glossary contents. |
| Created At | date and time | Datetime when the glossary was created. |
| Created By | text | Unique identifier of the user who created the glossary. |
| Updated At | date and time | Datetime when the glossary was updated. |
| Updated By | text | The unique identifier of the user who last updated the glossary. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
Import glossary
Creates a glossary from an exported glossary.
| Input | Type | Description |
|---|---|---|
| Importer As Fallback Steward | yes/no | Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. |
| Lookup User On Email | yes/no | Using email in the steward fields to lookup userIds in the identity service. |
| Space ID | text | The spaceId (leave blank or omit for personal). |
| Name | text | The name. |
| Tags | list | The tags. |
| Terms | list | The terms. Each entry has: ID, Name, Tags, Owner, Links To, Stewards, Relates To, Categories, Description, Abbreviation, Steward Details. |
| Space ID | text | The space id. |
| Overview | text | Overview of the glossary. |
| Categories | list | The categories. Each entry has: ID, Name, Parent ID, Stewards, Description, Steward Details. |
| Description | text | The description. |
| Term Template | object | The term template. Contains: Related Information. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Unique identifier of the glossary. |
| Name | text | Name of the glossary. |
| Tags | list | List of tags associated with the glossary. |
| Owner ID | text | The unique identifier of the glossary owner. |
| Space ID | text | The unique identifier of the space containing the glossary. |
| Overview | text | Overview of the glossary contents. |
| Created At | date and time | Datetime when the glossary was created. |
| Created By | text | Unique identifier of the user who created the glossary. |
| Updated At | date and time | Datetime when the glossary was updated. |
| Updated By | text | The unique identifier of the user who last updated the glossary. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
List glossaries
Lists the business glossaries.
| Input | Type | Description |
|---|---|---|
| Sort | choice | Optional resource field name to sort on, eg. Choices: name, +name, -name, description, +description, -description. |
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The id of the glossary to update. |
| Name required | text | Name of the glossary. |
| Tags | list | List of tags for glossary. |
| Space ID | text | Unique unique identifier of the space to contain the glossary. |
| Overview | text | Overview of the glossary content. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | Unique identifier of the glossary. |
| Name | text | Name of the glossary. |
| Tags | list | List of tags associated with the glossary. |
| Owner ID | text | The unique identifier of the glossary owner. |
| Space ID | text | The unique identifier of the space containing the glossary. |
| Overview | text | Overview of the glossary contents. |
| Created At | date and time | Datetime when the glossary was created. |
| Created By | text | Unique identifier of the user who created the glossary. |
| Updated At | date and time | Datetime when the glossary was updated. |
| Updated By | text | The unique identifier of the user who last updated the glossary. |
| Description | text | Description of the glossary. |
| Term Template | object | The term template. Contains: Related Information. |
Glossary category
Create glossary category
Creates a category in a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Name | text | The name of the category. |
| Parent ID | text | The parent id. |
| Stewards | list | This list contains the UIDs of the stewards of the category. |
| Description | text | The description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id for resolving updates in future imports/updates. |
| Name | text | The name. |
| Parent ID | text | The parent id. |
| Stewards | list | This list contains the UIDs of the stewards of the category. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the category. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
Delete glossary category
Deletes a category of a glossary.
| Input | Type | Description |
|---|---|---|
| Category ID required | text | The id for the category to delete. |
| Glossary ID required | choice | The id of the glossary. |
Result: The action was completed.
Get glossary category
Returns a category of a glossary.
| Input | Type | Description |
|---|---|---|
| Category ID required | text | The category id. |
| Glossary ID required | choice | The glossary id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id for resolving updates in future imports/updates. |
| Name | text | The name. |
| Parent ID | text | The parent id. |
| Stewards | list | This list contains the UIDs of the stewards of the category. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the category. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
List glossary categories
Lists the categories of a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Sort | choice | Optional resource field name to sort on, eg. Choices: description, +description, -description, name, +name, -name, update, +update, -update. |
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Category ID required | text | The category id. |
| Glossary ID required | choice | The glossary id. |
| Name | text | The name of the category. |
| Parent ID | text | The parent id. |
| Stewards | list | This list contains the UIDs of the stewards of the category. |
| Description | text | The description. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id for resolving updates in future imports/updates. |
| Name | text | The name. |
| Parent ID | text | The parent id. |
| Stewards | list | This list contains the UIDs of the stewards of the category. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the category. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
Glossary term
Change glossary term status
Sets the status of a glossary term, for example verified.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Term ID required | text | The term id. |
| Status required | choice | The status to update to. Choices: draft, verified, deprecated. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id. |
| Name | text | The name. |
| Tags | list | The tags. |
| Status | object | Terms status is used determine the status of a term. Contains: Type, Updated At, Updated By. |
| Links To | list | The 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. |
| Revision | number | The revision. |
| Stewards | list | This list contains the UIDs of the terms data stewards. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Relates To | list | Term relations assigned to this term. Each entry has: Type, Term ID. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the term. |
| Categories | list | The categories. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Referred Relations | list | Term relations where this term is the target of the relation. Each entry has: Type, Term ID. |
| Related Information | text | Related information for the term. |
Create glossary term
Creates a term in a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Name required | text | The name. |
| Tags | list | The tags. |
| Links To | list | The links to. Each entry has: Type, Resource ID, Resource Type, Sub Resource ID, Sub Resource Name, Sub Resource Type. |
| Stewards | list | This list contain the UIDs for the term's stewards. |
| Relates To | list | The relates to. Each entry has: Type, Term ID. |
| Categories | list | Category Ids that the term belongs to. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Related Information | text | Related information for the term. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id. |
| Name | text | The name. |
| Tags | list | The tags. |
| Status | object | Terms status is used determine the status of a term. Contains: Type, Updated At, Updated By. |
| Links To | list | The 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. |
| Revision | number | The revision. |
| Stewards | list | This list contains the UIDs of the terms data stewards. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Relates To | list | Term relations assigned to this term. Each entry has: Type, Term ID. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the term. |
| Categories | list | The categories. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Referred Relations | list | Term relations where this term is the target of the relation. Each entry has: Type, Term ID. |
| Related Information | text | Related information for the term. |
Delete glossary term
Deletes a term of a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Term ID required | text | The term id. |
Result: The action was completed.
Get glossary term
Returns a term of a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Term ID required | text | The term id. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id. |
| Name | text | The name. |
| Tags | list | The tags. |
| Status | object | Terms status is used determine the status of a term. Contains: Type, Updated At, Updated By. |
| Links To | list | The 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. |
| Revision | number | The revision. |
| Stewards | list | This list contains the UIDs of the terms data stewards. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Relates To | list | Term relations assigned to this term. Each entry has: Type, Term ID. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the term. |
| Categories | list | The categories. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Referred Relations | list | Term relations where this term is the target of the relation. Each entry has: Type, Term ID. |
| Related Information | text | Related information for the term. |
List glossary terms
Lists the terms of a glossary.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Filter | text | Optional SCIM filter to be used to filter terms Usable fields are - id - name - relatedInformation - description - abbreviation - tags - stewards - status - categories. |
| Sort | choice | Optional resource field name to sort on, eg. Choices: abbreviation, +abbreviation, -abbreviation, description, +description, -description, name, +name, -name, status, +status, -status, updated, +updated, -updated. |
| Limit | number | The maximum number of items to return, between 1 and 5000. Default: 100. From 1 to 5000. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| Items | list | The 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.
| Input | Type | Description |
|---|---|---|
| Glossary ID required | choice | The glossary id. |
| Term ID required | text | The term id. |
| Name required | text | The name. |
| Tags | list | The tags. |
| Links To | list | The links to. Each entry has: Type, Resource ID, Resource Type, Sub Resource ID, Sub Resource Name, Sub Resource Type. |
| Stewards | list | This list contain the UIDs for the term's stewards. |
| Relates To | list | The relates to. Each entry has: Type, Term ID. |
| Categories | list | Category Ids that the term belongs to. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Related Information | text | Related information for the term. |
Result: The result of the action.
| Field | Type | Description |
|---|---|---|
| ID | text | The id. |
| Name | text | The name. |
| Tags | list | The tags. |
| Status | object | Terms status is used determine the status of a term. Contains: Type, Updated At, Updated By. |
| Links To | list | The 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. |
| Revision | number | The revision. |
| Stewards | list | This list contains the UIDs of the terms data stewards. |
| Created At | date and time | The created at. |
| Created By | text | The created by. |
| Relates To | list | Term relations assigned to this term. Each entry has: Type, Term ID. |
| Updated At | date and time | The updated at. |
| Updated By | text | The uid of the user who last updated the term. |
| Categories | list | The categories. |
| Glossary ID | text | The glossary id. |
| Description | text | The description. |
| Abbreviation | text | The abbreviation. |
| Referred Relations | list | Term relations where this term is the target of the relation. Each entry has: Type, Term ID. |
| Related Information | text | Related information for the term. |