glossary

Creates, updates, deletes, gets or lists a glossary resource.

Overview

Name	glossary
Type	Resource
Id	azure.purview_data_map.glossary

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	The name of the glossary object.
categories	array	An array of categories.
classifications	array	An array of classifications.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
guid	string	The GUID of the object.
language	string	The language of the glossary.
lastModifiedTS	string	ETag for concurrency control.
longDescription	string	The long version description.
qualifiedName	string	The qualified name of the glossary object.
shortDescription	string	The short version of description.
terms	array	An array of related term headers.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
usage	string	The usage of the glossary.

get_category

Name	Datatype	Description
name	string	The name of the glossary object.
anchor	object	The glossary header with basic information.
childrenCategories	array	An array of children categories.
classifications	array	An array of classifications.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
guid	string	The GUID of the object.
lastModifiedTS	string	ETag for concurrency control.
longDescription	string	The long version description.
parentCategory	object	The header of the related category.
qualifiedName	string	The qualified name of the glossary object.
shortDescription	string	The short version of description.
terms	array	An array of related term headers.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.

get_term

Name	Datatype	Description
name	string	The name of the glossary object.
abbreviation	string	The abbreviation of the term.
anchor	object	The glossary header with basic information.
antonyms	array	An array of related term headers as antonyms.
assignedEntities	array	An array of related object IDs.
attributes	object	The custom attributes of the term, which is map>. The key of the first layer map is term template name.
categories	array	An array of term categorization headers.
classifications	array	An array of classifications.
classifies	array	An array of related term headers.
contacts	object	The dictionary of contacts for terms. Key could be Expert or Steward.
createTime	integer	The created time of the record.
createdBy	string	The user who created the record.
examples	array	An array of examples.
guid	string	The GUID of the object.
hierarchyInfo	array	The hierarchy information of the term.
isA	array	An array of related term headers indicating the is-a relationship.
lastModifiedTS	string	ETag for concurrency control.
longDescription	string	The long version description.
nickName	string	The nick name of the term.
preferredTerms	array	An array of preferred related term headers.
preferredToTerms	array	An array of related term headers that are preferred to.
qualifiedName	string	The qualified name of the glossary object.
replacedBy	array	An array of related term headers that are replaced by.
replacementTerms	array	An array of related term headers for replacement.
resources	array	An array of resource link for term.
seeAlso	array	An array of related term headers for see also.
shortDescription	string	The short version of description.
status	string	Status of the AtlasGlossaryTerm. Known values are: "Draft", "Approved", "Alert", and "Expired". (Draft, Approved, Alert, Expired)
synonyms	array	An array of related term headers as synonyms.
templateName	array	The name of the template.
translatedTerms	array	An array of translated related term headers.
translationTerms	array	An array of related term headers for translation.
updateTime	integer	The update time of the record.
updatedBy	string	The user who updated the record.
usage	string	The usage of the term.
validValues	array	An array of related term headers as valid values.
validValuesFor	array	An array of related term headers as valid values for other records.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	glossary_id, endpoint		Get a specific Glossary by its GUID.
get_category	select	category_id, endpoint		Get specific glossary category by its GUID.
get_term	select	term_id, endpoint		Get a specific glossary term by its GUID.
create	insert	endpoint		Create a glossary.
update	update	glossary_id, endpoint	ignoreTermsAndCategories	Update the given glossary.
delete	delete	glossary_id, endpoint		Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.
update_category	exec	category_id, endpoint		Update the given glossary category by its GUID.
delete_category	exec	category_id, endpoint		Delete a glossary category.
get_related_categories	exec	category_id, endpoint	limit, offset, sort	Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
get_category_terms	exec	category_id, endpoint	limit, offset, sort	Get all terms associated with the specific category.
update_term	exec	term_id, endpoint	includeTermHierarchy	Update the given glossary term by its GUID.
get_entities_assigned_with_term	exec	term_id, endpoint	limit, offset, sort	List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.
assign_term_to_entities	exec	term_id, endpoint		Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. Entities Create Or Update operation _ is an alternative to assign a term to multiple entities.
delete_term_assignment_from_entities	exec	term_id, endpoint		Delete the term assignment for the given list of related objects.
get_related_terms	exec	term_id, endpoint	limit, offset, sort	Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.
get_categories	exec	glossary_id, endpoint	limit, offset, sort	Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
get_categories_headers	exec	glossary_id, endpoint	limit, offset, sort	Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
get_detailed	exec	glossary_id, endpoint		Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.
get_terms	exec	glossary_id, endpoint	limit, offset, sort	Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
get_term_headers	exec	glossary_id, endpoint	limit, offset, sort	Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
batch_get	exec	endpoint	limit, offset, sort, ignoreTermsAndCategories	Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.
create_categories	exec	endpoint		Create glossary category in bulk.
create_category	exec	endpoint		Create a glossary category.
partial_update_category	exec	category_id, endpoint		Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.
create_term	exec	endpoint	includeTermHierarchy	Create a glossary term.
delete_term	exec	term_id, endpoint		Delete a glossary term.
partial_update_term	exec	term_id, endpoint	includeTermHierarchy	Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.
create_terms	exec	endpoint	includeTermHierarchy	Create glossary terms in bulk.
partial_update	exec	glossary_id, endpoint	ignoreTermsAndCategories	Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
category_id	string	The globally unique identifier of the category. Required.
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
glossary_id	string	The globally unique identifier for glossary. Required.
term_id	string	The globally unique identifier for glossary term. Required.
ignoreTermsAndCategories	boolean	Whether ignore terms and categories. Default value is None.
includeTermHierarchy	boolean	Whether include term hierarchy. Default value is None.
limit	integer	The page size - by default there is no paging. Default value is None.
offset	integer	The offset for pagination purpose. Default value is None.
sort	string	The sort order, ASC (default) or DESC. Default value is None.

SELECT examples

get

Get a specific Glossary by its GUID.

SELECT
name,
categories,
classifications,
createTime,
createdBy,
guid,
language,
lastModifiedTS,
longDescription,
qualifiedName,
shortDescription,
terms,
updateTime,
updatedBy,
usage
FROM azure.purview_data_map.glossary
WHERE glossary_id = '{{ glossary_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_category

Get specific glossary category by its GUID.

SELECT
name,
anchor,
childrenCategories,
classifications,
createTime,
createdBy,
guid,
lastModifiedTS,
longDescription,
parentCategory,
qualifiedName,
shortDescription,
terms,
updateTime,
updatedBy
FROM azure.purview_data_map.glossary
WHERE category_id = '{{ category_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

get_term

Get a specific glossary term by its GUID.

SELECT
name,
abbreviation,
anchor,
antonyms,
assignedEntities,
attributes,
categories,
classifications,
classifies,
contacts,
createTime,
createdBy,
examples,
guid,
hierarchyInfo,
isA,
lastModifiedTS,
longDescription,
nickName,
preferredTerms,
preferredToTerms,
qualifiedName,
replacedBy,
replacementTerms,
resources,
seeAlso,
shortDescription,
status,
synonyms,
templateName,
translatedTerms,
translationTerms,
updateTime,
updatedBy,
usage,
validValues,
validValuesFor
FROM azure.purview_data_map.glossary
WHERE term_id = '{{ term_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create

Create a glossary.

INSERT INTO azure.purview_data_map.glossary (
guid,
classifications,
longDescription,
name,
qualifiedName,
shortDescription,
lastModifiedTS,
createTime,
createdBy,
updateTime,
updatedBy,
categories,
language,
terms,
usage,
endpoint
)
SELECT 
'{{ guid }}',
'{{ classifications }}',
'{{ longDescription }}',
'{{ name }}',
'{{ qualifiedName }}',
'{{ shortDescription }}',
'{{ lastModifiedTS }}',
{{ createTime }},
'{{ createdBy }}',
{{ updateTime }},
'{{ updatedBy }}',
'{{ categories }}',
'{{ language }}',
'{{ terms }}',
'{{ usage }}',
'{{ endpoint }}'
RETURNING
name,
categories,
classifications,
createTime,
createdBy,
guid,
language,
lastModifiedTS,
longDescription,
qualifiedName,
shortDescription,
terms,
updateTime,
updatedBy,
usage
;

Manifest

# Description fields are for documentation purposes
- name: glossary
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the glossary resource.
  - name: guid
    value: "{{ guid }}"
    description: |
      The GUID of the object.
  - name: classifications
    description: |
      An array of classifications.
    value:
      - attributes: "{{ attributes }}"
        typeName: "{{ typeName }}"
        lastModifiedTS: "{{ lastModifiedTS }}"
        entityGuid: "{{ entityGuid }}"
        entityStatus: "{{ entityStatus }}"
        removePropagationsOnEntityDelete: {{ removePropagationsOnEntityDelete }}
        validityPeriods: "{{ validityPeriods }}"
  - name: longDescription
    value: "{{ longDescription }}"
    description: |
      The long version description.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the glossary object.
  - name: qualifiedName
    value: "{{ qualifiedName }}"
    description: |
      The qualified name of the glossary object.
  - name: shortDescription
    value: "{{ shortDescription }}"
    description: |
      The short version of description.
  - name: lastModifiedTS
    value: "{{ lastModifiedTS }}"
    description: |
      ETag for concurrency control.
  - name: createTime
    value: {{ createTime }}
    description: |
      The created time of the record.
  - name: createdBy
    value: "{{ createdBy }}"
    description: |
      The user who created the record.
  - name: updateTime
    value: {{ updateTime }}
    description: |
      The update time of the record.
  - name: updatedBy
    value: "{{ updatedBy }}"
    description: |
      The user who updated the record.
  - name: categories
    description: |
      An array of categories.
    value:
      - categoryGuid: "{{ categoryGuid }}"
        description: "{{ description }}"
        displayText: "{{ displayText }}"
        parentCategoryGuid: "{{ parentCategoryGuid }}"
        relationGuid: "{{ relationGuid }}"
  - name: language
    value: "{{ language }}"
    description: |
      The language of the glossary.
  - name: terms
    description: |
      An array of related term headers.
    value:
      - description: "{{ description }}"
        displayText: "{{ displayText }}"
        expression: "{{ expression }}"
        relationGuid: "{{ relationGuid }}"
        status: "{{ status }}"
        steward: "{{ steward }}"
        termGuid: "{{ termGuid }}"
  - name: usage
    value: "{{ usage }}"
    description: |
      The usage of the glossary.

UPDATE examples

update

Update the given glossary.

UPDATE azure.purview_data_map.glossary
SET 
guid = '{{ guid }}',
classifications = '{{ classifications }}',
longDescription = '{{ longDescription }}',
name = '{{ name }}',
qualifiedName = '{{ qualifiedName }}',
shortDescription = '{{ shortDescription }}',
lastModifiedTS = '{{ lastModifiedTS }}',
createTime = {{ createTime }},
createdBy = '{{ createdBy }}',
updateTime = {{ updateTime }},
updatedBy = '{{ updatedBy }}',
categories = '{{ categories }}',
language = '{{ language }}',
terms = '{{ terms }}',
usage = '{{ usage }}'
WHERE 
glossary_id = '{{ glossary_id }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ignoreTermsAndCategories = {{ ignoreTermsAndCategories}}
RETURNING
name,
categories,
classifications,
createTime,
createdBy,
guid,
language,
lastModifiedTS,
longDescription,
qualifiedName,
shortDescription,
terms,
updateTime,
updatedBy,
usage;

DELETE examples

delete

Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories.

DELETE FROM azure.purview_data_map.glossary
WHERE glossary_id = '{{ glossary_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

update_category

Update the given glossary category by its GUID.

EXEC azure.purview_data_map.glossary.update_category 
@category_id='{{ category_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"anchor": "{{ anchor }}", 
"childrenCategories": "{{ childrenCategories }}", 
"parentCategory": "{{ parentCategory }}", 
"terms": "{{ terms }}"
}'
;

delete_category

Delete a glossary category.

EXEC azure.purview_data_map.glossary.delete_category 
@category_id='{{ category_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_related_categories

Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

EXEC azure.purview_data_map.glossary.get_related_categories 
@category_id='{{ category_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

get_category_terms

Get all terms associated with the specific category.

EXEC azure.purview_data_map.glossary.get_category_terms 
@category_id='{{ category_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

update_term

Update the given glossary term by its GUID.

EXEC azure.purview_data_map.glossary.update_term 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }} 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"abbreviation": "{{ abbreviation }}", 
"templateName": "{{ templateName }}", 
"anchor": "{{ anchor }}", 
"antonyms": "{{ antonyms }}", 
"status": "{{ status }}", 
"nickName": "{{ nickName }}", 
"hierarchyInfo": "{{ hierarchyInfo }}", 
"resources": "{{ resources }}", 
"contacts": "{{ contacts }}", 
"attributes": "{{ attributes }}", 
"assignedEntities": "{{ assignedEntities }}", 
"categories": "{{ categories }}", 
"classifies": "{{ classifies }}", 
"examples": "{{ examples }}", 
"isA": "{{ isA }}", 
"preferredTerms": "{{ preferredTerms }}", 
"preferredToTerms": "{{ preferredToTerms }}", 
"replacedBy": "{{ replacedBy }}", 
"replacementTerms": "{{ replacementTerms }}", 
"seeAlso": "{{ seeAlso }}", 
"synonyms": "{{ synonyms }}", 
"translatedTerms": "{{ translatedTerms }}", 
"translationTerms": "{{ translationTerms }}", 
"usage": "{{ usage }}", 
"validValues": "{{ validValues }}", 
"validValuesFor": "{{ validValuesFor }}"
}'
;

get_entities_assigned_with_term

List all related objects assigned with the specified term. Recommend using limit/offset to get pagination result.

EXEC azure.purview_data_map.glossary.get_entities_assigned_with_term 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

assign_term_to_entities

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. Entities Create Or Update operation _ is an alternative to assign a term to multiple entities.

EXEC azure.purview_data_map.glossary.assign_term_to_entities 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guid": "{{ guid }}", 
"typeName": "{{ typeName }}", 
"uniqueAttributes": "{{ uniqueAttributes }}", 
"displayText": "{{ displayText }}", 
"entityStatus": "{{ entityStatus }}", 
"relationshipType": "{{ relationshipType }}", 
"relationshipAttributes": "{{ relationshipAttributes }}", 
"relationshipGuid": "{{ relationshipGuid }}", 
"relationshipStatus": "{{ relationshipStatus }}"
}'
;

delete_term_assignment_from_entities

Delete the term assignment for the given list of related objects.

EXEC azure.purview_data_map.glossary.delete_term_assignment_from_entities 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guid": "{{ guid }}", 
"typeName": "{{ typeName }}", 
"uniqueAttributes": "{{ uniqueAttributes }}", 
"displayText": "{{ displayText }}", 
"entityStatus": "{{ entityStatus }}", 
"relationshipType": "{{ relationshipType }}", 
"relationshipAttributes": "{{ relationshipAttributes }}", 
"relationshipGuid": "{{ relationshipGuid }}", 
"relationshipStatus": "{{ relationshipStatus }}"
}'
;

get_related_terms

Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed.

EXEC azure.purview_data_map.glossary.get_related_terms 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

get_categories

Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.

EXEC azure.purview_data_map.glossary.get_categories 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

get_categories_headers

Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

EXEC azure.purview_data_map.glossary.get_categories_headers 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

get_detailed

Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms and GET /datamap/api/atlas/v2/glossary/{glossaryId}/categories.

EXEC azure.purview_data_map.glossary.get_detailed 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

get_terms

Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.

EXEC azure.purview_data_map.glossary.get_terms 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

get_term_headers

Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.

EXEC azure.purview_data_map.glossary.get_term_headers 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}'
;

batch_get

Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories separately using 'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' and 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories'.

EXEC azure.purview_data_map.glossary.batch_get 
@endpoint='{{ endpoint }}' --required, 
@limit='{{ limit }}', 
@offset='{{ offset }}', 
@sort='{{ sort }}', 
@ignoreTermsAndCategories={{ ignoreTermsAndCategories }}
;

create_categories

Create glossary category in bulk.

EXEC azure.purview_data_map.glossary.create_categories 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"anchor": "{{ anchor }}", 
"childrenCategories": "{{ childrenCategories }}", 
"parentCategory": "{{ parentCategory }}", 
"terms": "{{ terms }}"
}'
;

create_category

Create a glossary category.

EXEC azure.purview_data_map.glossary.create_category 
@endpoint='{{ endpoint }}' --required 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"anchor": "{{ anchor }}", 
"childrenCategories": "{{ childrenCategories }}", 
"parentCategory": "{{ parentCategory }}", 
"terms": "{{ terms }}"
}'
;

partial_update_category

Update the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category.

EXEC azure.purview_data_map.glossary.partial_update_category 
@category_id='{{ category_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_term

Create a glossary term.

EXEC azure.purview_data_map.glossary.create_term 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }} 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"abbreviation": "{{ abbreviation }}", 
"templateName": "{{ templateName }}", 
"anchor": "{{ anchor }}", 
"antonyms": "{{ antonyms }}", 
"status": "{{ status }}", 
"nickName": "{{ nickName }}", 
"hierarchyInfo": "{{ hierarchyInfo }}", 
"resources": "{{ resources }}", 
"contacts": "{{ contacts }}", 
"attributes": "{{ attributes }}", 
"assignedEntities": "{{ assignedEntities }}", 
"categories": "{{ categories }}", 
"classifies": "{{ classifies }}", 
"examples": "{{ examples }}", 
"isA": "{{ isA }}", 
"preferredTerms": "{{ preferredTerms }}", 
"preferredToTerms": "{{ preferredToTerms }}", 
"replacedBy": "{{ replacedBy }}", 
"replacementTerms": "{{ replacementTerms }}", 
"seeAlso": "{{ seeAlso }}", 
"synonyms": "{{ synonyms }}", 
"translatedTerms": "{{ translatedTerms }}", 
"translationTerms": "{{ translationTerms }}", 
"usage": "{{ usage }}", 
"validValues": "{{ validValues }}", 
"validValuesFor": "{{ validValuesFor }}"
}'
;

delete_term

Delete a glossary term.

EXEC azure.purview_data_map.glossary.delete_term 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

partial_update_term

Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

EXEC azure.purview_data_map.glossary.partial_update_term 
@term_id='{{ term_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }}
;

create_terms

Create glossary terms in bulk.

EXEC azure.purview_data_map.glossary.create_terms 
@endpoint='{{ endpoint }}' --required, 
@includeTermHierarchy={{ includeTermHierarchy }} 
@@json=
'{
"guid": "{{ guid }}", 
"classifications": "{{ classifications }}", 
"longDescription": "{{ longDescription }}", 
"name": "{{ name }}", 
"qualifiedName": "{{ qualifiedName }}", 
"shortDescription": "{{ shortDescription }}", 
"lastModifiedTS": "{{ lastModifiedTS }}", 
"createTime": {{ createTime }}, 
"createdBy": "{{ createdBy }}", 
"updateTime": {{ updateTime }}, 
"updatedBy": "{{ updatedBy }}", 
"abbreviation": "{{ abbreviation }}", 
"templateName": "{{ templateName }}", 
"anchor": "{{ anchor }}", 
"antonyms": "{{ antonyms }}", 
"status": "{{ status }}", 
"nickName": "{{ nickName }}", 
"hierarchyInfo": "{{ hierarchyInfo }}", 
"resources": "{{ resources }}", 
"contacts": "{{ contacts }}", 
"attributes": "{{ attributes }}", 
"assignedEntities": "{{ assignedEntities }}", 
"categories": "{{ categories }}", 
"classifies": "{{ classifies }}", 
"examples": "{{ examples }}", 
"isA": "{{ isA }}", 
"preferredTerms": "{{ preferredTerms }}", 
"preferredToTerms": "{{ preferredToTerms }}", 
"replacedBy": "{{ replacedBy }}", 
"replacementTerms": "{{ replacementTerms }}", 
"seeAlso": "{{ seeAlso }}", 
"synonyms": "{{ synonyms }}", 
"translatedTerms": "{{ translatedTerms }}", 
"translationTerms": "{{ translationTerms }}", 
"usage": "{{ usage }}", 
"validValues": "{{ validValues }}", 
"validValuesFor": "{{ validValuesFor }}"
}'
;

partial_update

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription, longDescription, language and usage for glossary. Recommend using 'ignoreTermsAndCategories=true' to reduce response body size.

EXEC azure.purview_data_map.glossary.partial_update 
@glossary_id='{{ glossary_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@ignoreTermsAndCategories={{ ignoreTermsAndCategories }}
;