Package com.azure.analytics.purview.datamap

Class GlossaryClient

java.lang.Object

com.azure.analytics.purview.datamap.GlossaryClient

public final class GlossaryClient
extends Object

Initializes a new instance of the synchronous DataMapClient type.

Method Summary

Modifier and Type	Method	Description
void	assignTermToEntities(String termId, List<AtlasRelatedObjectId> body)	Assign the given term to the provided list of related objects.
com.azure.core.http.rest.Response<Void>	assignTermToEntitiesWithResponse(String termId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Assign the given term to the provided list of related objects.
List<AtlasGlossary>	batchGet()	Get all glossaries.
List<AtlasGlossary>	batchGet(Integer limit, Integer offset, String sort, Boolean ignoreTermsAndCategories)	Get all glossaries.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	batchGetWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)	Get all glossaries.
AtlasGlossary	create(AtlasGlossary body)	Create a glossary.
List<AtlasGlossaryCategory>	createCategories(List<AtlasGlossaryCategory> body)	Create glossary category in bulk.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createCategoriesWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create glossary category in bulk.
AtlasGlossaryCategory	createCategory(AtlasGlossaryCategory body)	Create a glossary category.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createCategoryWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create a glossary category.
AtlasGlossaryTerm	createTerm(AtlasGlossaryTerm body)	Create a glossary term.
AtlasGlossaryTerm	createTerm(AtlasGlossaryTerm body, Boolean includeTermHierarchy)	Create a glossary term.
List<AtlasGlossaryTerm>	createTerms(List<AtlasGlossaryTerm> body)	Create glossary terms in bulk.
List<AtlasGlossaryTerm>	createTerms(List<AtlasGlossaryTerm> body, Boolean includeTermHierarchy)	Create glossary terms in bulk.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createTermsWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create glossary terms in bulk.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createTermWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create a glossary term.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	createWithResponse(com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Create a glossary.
void	delete(String glossaryId)	Delete a glossary.
void	deleteCategory(String categoryId)	Delete a glossary category.
com.azure.core.http.rest.Response<Void>	deleteCategoryWithResponse(String categoryId, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a glossary category.
void	deleteTerm(String termId)	Delete a glossary term.
void	deleteTermAssignmentFromEntities(String termId, List<AtlasRelatedObjectId> body)	Delete the term assignment for the given list of related objects.
com.azure.core.http.rest.Response<Void>	deleteTermAssignmentFromEntitiesWithResponse(String termId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Delete the term assignment for the given list of related objects.
com.azure.core.http.rest.Response<Void>	deleteTermWithResponse(String termId, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a glossary term.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Delete a glossary.
AtlasGlossary	get(String glossaryId)	Get a specific Glossary by its GUID.
List<AtlasGlossaryCategory>	getCategories(String glossaryId)	Get the categories belonging to a specific glossary.
List<AtlasGlossaryCategory>	getCategories(String glossaryId, Integer limit, Integer offset, String sort)	Get the categories belonging to a specific glossary.
List<AtlasRelatedCategoryHeader>	getCategoriesHeaders(String glossaryId)	Get the category headers belonging to a specific glossary.
List<AtlasRelatedCategoryHeader>	getCategoriesHeaders(String glossaryId, Integer limit, Integer offset, String sort)	Get the category headers belonging to a specific glossary.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getCategoriesHeadersWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get the category headers belonging to a specific glossary.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getCategoriesWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get the categories belonging to a specific glossary.
AtlasGlossaryCategory	getCategory(String categoryId)	Get specific glossary category by its GUID.
List<AtlasRelatedTermHeader>	getCategoryTerms(String categoryId)	Get all terms associated with the specific category.
List<AtlasRelatedTermHeader>	getCategoryTerms(String categoryId, Integer limit, Integer offset, String sort)	Get all terms associated with the specific category.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getCategoryTermsWithResponse(String categoryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get all terms associated with the specific category.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getCategoryWithResponse(String categoryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get specific glossary category by its GUID.
AtlasGlossaryExtInfo	getDetailed(String glossaryId)	Get a specific glossary with detailed information.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getDetailedWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get a specific glossary with detailed information.
List<AtlasRelatedObjectId>	getEntitiesAssignedWithTerm(String termId)	List all related objects assigned with the specified term.
List<AtlasRelatedObjectId>	getEntitiesAssignedWithTerm(String termId, Integer limit, Integer offset, String sort)	List all related objects assigned with the specified term.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getEntitiesAssignedWithTermWithResponse(String termId, com.azure.core.http.rest.RequestOptions requestOptions)	List all related objects assigned with the specified term.
Map<String,List<AtlasRelatedCategoryHeader>>	getRelatedCategories(String categoryId)	Get all related categories (parent and children).
Map<String,List<AtlasRelatedCategoryHeader>>	getRelatedCategories(String categoryId, Integer limit, Integer offset, String sort)	Get all related categories (parent and children).
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getRelatedCategoriesWithResponse(String categoryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get all related categories (parent and children).
Map<String,List<AtlasRelatedTermHeader>>	getRelatedTerms(String termId)	Get all related terms for a specific term by its GUID.
Map<String,List<AtlasRelatedTermHeader>>	getRelatedTerms(String termId, Integer limit, Integer offset, String sort)	Get all related terms for a specific term by its GUID.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getRelatedTermsWithResponse(String termId, com.azure.core.http.rest.RequestOptions requestOptions)	Get all related terms for a specific term by its GUID.
AtlasGlossaryTerm	getTerm(String termId)	Get a specific glossary term by its GUID.
List<AtlasRelatedTermHeader>	getTermHeaders(String glossaryId)	Get term headers belonging to a specific glossary.
List<AtlasRelatedTermHeader>	getTermHeaders(String glossaryId, Integer limit, Integer offset, String sort)	Get term headers belonging to a specific glossary.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getTermHeadersWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get term headers belonging to a specific glossary.
List<AtlasGlossaryTerm>	getTerms(String glossaryId)	Get terms belonging to a specific glossary.
List<AtlasGlossaryTerm>	getTerms(String glossaryId, Integer limit, Integer offset, String sort)	Get terms belonging to a specific glossary.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getTermsWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get terms belonging to a specific glossary.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getTermWithResponse(String termId, com.azure.core.http.rest.RequestOptions requestOptions)	Get a specific glossary term by its GUID.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	getWithResponse(String glossaryId, com.azure.core.http.rest.RequestOptions requestOptions)	Get a specific Glossary by its GUID.
AtlasGlossary	partialUpdate(String glossaryId, Map<String,String> body)	Update the glossary partially.
AtlasGlossary	partialUpdate(String glossaryId, Map<String,String> body, Boolean ignoreTermsAndCategories)	Update the glossary partially.
AtlasGlossaryCategory	partialUpdateCategory(String categoryId, Map<String,String> body)	Update the glossary category partially.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	partialUpdateCategoryWithResponse(String categoryId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the glossary category partially.
AtlasGlossaryTerm	partialUpdateTerm(String termId, Map<String,String> body)	Update the glossary term partially.
AtlasGlossaryTerm	partialUpdateTerm(String termId, Map<String,String> body, Boolean includeTermHierarchy)	Update the glossary term partially.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	partialUpdateTermWithResponse(String termId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the glossary term partially.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	partialUpdateWithResponse(String glossaryId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the glossary partially.
AtlasGlossary	update(String glossaryId, AtlasGlossary body)	Update the given glossary.
AtlasGlossary	update(String glossaryId, AtlasGlossary body, Boolean ignoreTermsAndCategories)	Update the given glossary.
AtlasGlossaryCategory	updateCategory(String categoryId, AtlasGlossaryCategory body)	Update the given glossary category by its GUID.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	updateCategoryWithResponse(String categoryId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the given glossary category by its GUID.
AtlasGlossaryTerm	updateTerm(String termId, AtlasGlossaryTerm body)	Update the given glossary term by its GUID.
AtlasGlossaryTerm	updateTerm(String termId, AtlasGlossaryTerm body, Boolean includeTermHierarchy)	Update the given glossary term by its GUID.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	updateTermWithResponse(String termId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the given glossary term by its GUID.
com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>	updateWithResponse(String glossaryId, com.azure.core.util.BinaryData body, com.azure.core.http.rest.RequestOptions requestOptions)	Update the given glossary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

batchGetWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> batchGetWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.
ignoreTermsAndCategories	Boolean	No	Whether ignore terms and categories

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         categories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 parentCategoryGuid: String (Optional)
                 relationGuid: String (Optional)
             }
         ]
         language: String (Optional)
         terms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
         usage: String (Optional)
     }
 ]
 
 

Parameters:

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all glossaries along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary.

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary object along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createCategoriesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createCategoriesWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create glossary category in bulk.

Request Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         childrenCategories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 parentCategoryGuid: String (Optional)
                 relationGuid: String (Optional)
             }
         ]
         parentCategory (Optional): (recursive schema, see parentCategory above)
         terms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
     }
 ]
 
 

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         childrenCategories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 parentCategoryGuid: String (Optional)
                 relationGuid: String (Optional)
             }
         ]
         parentCategory (Optional): (recursive schema, see parentCategory above)
         terms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

body - An array of glossary category definitions to be created.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createCategoryWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary category.

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary category along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCategoryWithResponse(String categoryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get specific glossary category by its GUID.

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

categoryId - The globally unique identifier of the category.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

specific glossary category by its GUID along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateCategoryWithResponse(String categoryId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary category by its GUID.

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

categoryId - The globally unique identifier of the category.

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary category along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteCategoryWithResponse

public com.azure.core.http.rest.Response<Void> deleteCategoryWithResponse(String categoryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete a glossary category.

Parameters:

categoryId - The globally unique identifier of the category.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

partialUpdateCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateCategoryWithResponse(String categoryId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Request Body Schema

 
 {
     String: String (Required)
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     childrenCategories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     parentCategory (Optional): (recursive schema, see parentCategory above)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

categoryId - The globally unique identifier of the category.

body - A map containing keys as attribute names and values as corresponding attribute values for partial update.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary category along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getRelatedCategoriesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getRelatedCategoriesWithResponse(String categoryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     String (Required): [
          (Required){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

categoryId - The globally unique identifier of the category.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all related categories (parent and children) along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getCategoryTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCategoryTermsWithResponse(String categoryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get all terms associated with the specific category.

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         description: String (Optional)
         displayText: String (Optional)
         expression: String (Optional)
         relationGuid: String (Optional)
         status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         steward: String (Optional)
         termGuid: String (Optional)
     }
 ]
 
 

Parameters:

categoryId - The globally unique identifier of the category.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all terms associated with the specific category along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createTermWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary term.

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary term along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTermWithResponse(String termId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get a specific glossary term by its GUID.

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

termId - The globally unique identifier for glossary term.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a specific glossary term by its GUID along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateTermWithResponse(String termId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary term by its GUID.

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

termId - The globally unique identifier for glossary term.

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary term along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteTermWithResponse

public com.azure.core.http.rest.Response<Void> deleteTermWithResponse(String termId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Delete a glossary term.

Parameters:

termId - The globally unique identifier for glossary term.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

partialUpdateTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateTermWithResponse(String termId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     String: String (Required)
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     abbreviation: String (Optional)
     templateName (Optional): [
         BinaryData (Optional)
     ]
     anchor (Optional): {
         displayText: String (Optional)
         glossaryGuid: String (Optional)
         relationGuid: String (Optional)
     }
     antonyms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     status: String(Draft/Approved/Alert/Expired) (Optional)
     nickName: String (Optional)
     hierarchyInfo (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             name: String (Optional)
             displayText: String (Optional)
             itemPath: String (Optional)
             resourceId: String (Optional)
             properties (Optional): {
                 String: BinaryData (Required)
             }
         }
     ]
     resources (Optional): [
          (Optional){
             displayName: String (Optional)
             url: String (Optional)
         }
     ]
     contacts (Optional): {
         String (Required): [
              (Required){
                 id: String (Optional)
                 info: String (Optional)
             }
         ]
     }
     attributes (Optional): {
         String (Required): {
             String: BinaryData (Required)
         }
     }
     assignedEntities (Optional): [
          (Optional){
             guid: String (Optional)
             typeName: String (Optional)
             uniqueAttributes (Optional): {
                 String: BinaryData (Required)
             }
             displayText: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             relationshipType: String (Optional)
             relationshipAttributes (Optional): {
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
             }
             relationshipGuid: String (Optional)
             relationshipStatus: String(ACTIVE/DELETED) (Optional)
         }
     ]
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         }
     ]
     classifies (Optional): [
         (recursive schema, see above)
     ]
     examples (Optional): [
         String (Optional)
     ]
     isA (Optional): [
         (recursive schema, see above)
     ]
     preferredTerms (Optional): [
         (recursive schema, see above)
     ]
     preferredToTerms (Optional): [
         (recursive schema, see above)
     ]
     replacedBy (Optional): [
         (recursive schema, see above)
     ]
     replacementTerms (Optional): [
         (recursive schema, see above)
     ]
     seeAlso (Optional): [
         (recursive schema, see above)
     ]
     synonyms (Optional): [
         (recursive schema, see above)
     ]
     translatedTerms (Optional): [
         (recursive schema, see above)
     ]
     translationTerms (Optional): [
         (recursive schema, see above)
     ]
     usage: String (Optional)
     validValues (Optional): [
         (recursive schema, see above)
     ]
     validValuesFor (Optional): [
         (recursive schema, see above)
     ]
 }
 
 

Parameters:

termId - The globally unique identifier for glossary term.

body - A map containing keys as attribute names and values as corresponding attribute values to be updated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary term along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createTermsWithResponse(com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Create glossary terms in bulk.

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         abbreviation: String (Optional)
         templateName (Optional): [
             BinaryData (Optional)
         ]
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         antonyms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
         status: String(Draft/Approved/Alert/Expired) (Optional)
         nickName: String (Optional)
         hierarchyInfo (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 name: String (Optional)
                 displayText: String (Optional)
                 itemPath: String (Optional)
                 resourceId: String (Optional)
                 properties (Optional): {
                     String: BinaryData (Required)
                 }
             }
         ]
         resources (Optional): [
              (Optional){
                 displayName: String (Optional)
                 url: String (Optional)
             }
         ]
         contacts (Optional): {
             String (Required): [
                  (Required){
                     id: String (Optional)
                     info: String (Optional)
                 }
             ]
         }
         attributes (Optional): {
             String (Required): {
                 String: BinaryData (Required)
             }
         }
         assignedEntities (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 displayText: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 relationshipType: String (Optional)
                 relationshipAttributes (Optional): {
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                 }
                 relationshipGuid: String (Optional)
                 relationshipStatus: String(ACTIVE/DELETED) (Optional)
             }
         ]
         categories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             }
         ]
         classifies (Optional): [
             (recursive schema, see above)
         ]
         examples (Optional): [
             String (Optional)
         ]
         isA (Optional): [
             (recursive schema, see above)
         ]
         preferredTerms (Optional): [
             (recursive schema, see above)
         ]
         preferredToTerms (Optional): [
             (recursive schema, see above)
         ]
         replacedBy (Optional): [
             (recursive schema, see above)
         ]
         replacementTerms (Optional): [
             (recursive schema, see above)
         ]
         seeAlso (Optional): [
             (recursive schema, see above)
         ]
         synonyms (Optional): [
             (recursive schema, see above)
         ]
         translatedTerms (Optional): [
             (recursive schema, see above)
         ]
         translationTerms (Optional): [
             (recursive schema, see above)
         ]
         usage: String (Optional)
         validValues (Optional): [
             (recursive schema, see above)
         ]
         validValuesFor (Optional): [
             (recursive schema, see above)
         ]
     }
 ]
 
 

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         abbreviation: String (Optional)
         templateName (Optional): [
             BinaryData (Optional)
         ]
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         antonyms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
         status: String(Draft/Approved/Alert/Expired) (Optional)
         nickName: String (Optional)
         hierarchyInfo (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 name: String (Optional)
                 displayText: String (Optional)
                 itemPath: String (Optional)
                 resourceId: String (Optional)
                 properties (Optional): {
                     String: BinaryData (Required)
                 }
             }
         ]
         resources (Optional): [
              (Optional){
                 displayName: String (Optional)
                 url: String (Optional)
             }
         ]
         contacts (Optional): {
             String (Required): [
                  (Required){
                     id: String (Optional)
                     info: String (Optional)
                 }
             ]
         }
         attributes (Optional): {
             String (Required): {
                 String: BinaryData (Required)
             }
         }
         assignedEntities (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 displayText: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 relationshipType: String (Optional)
                 relationshipAttributes (Optional): {
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                 }
                 relationshipGuid: String (Optional)
                 relationshipStatus: String(ACTIVE/DELETED) (Optional)
             }
         ]
         categories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             }
         ]
         classifies (Optional): [
             (recursive schema, see above)
         ]
         examples (Optional): [
             String (Optional)
         ]
         isA (Optional): [
             (recursive schema, see above)
         ]
         preferredTerms (Optional): [
             (recursive schema, see above)
         ]
         preferredToTerms (Optional): [
             (recursive schema, see above)
         ]
         replacedBy (Optional): [
             (recursive schema, see above)
         ]
         replacementTerms (Optional): [
             (recursive schema, see above)
         ]
         seeAlso (Optional): [
             (recursive schema, see above)
         ]
         synonyms (Optional): [
             (recursive schema, see above)
         ]
         translatedTerms (Optional): [
             (recursive schema, see above)
         ]
         translationTerms (Optional): [
             (recursive schema, see above)
         ]
         usage: String (Optional)
         validValues (Optional): [
             (recursive schema, see above)
         ]
         validValuesFor (Optional): [
             (recursive schema, see above)
         ]
     }
 ]
 
 

Parameters:

body - An array of glossary term definitions to be created in bulk.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getEntitiesAssignedWithTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getEntitiesAssignedWithTermWithResponse(String termId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         typeName: String (Optional)
         uniqueAttributes (Optional): {
             String: BinaryData (Required)
         }
         displayText: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         relationshipType: String (Optional)
         relationshipAttributes (Optional): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
         }
         relationshipGuid: String (Optional)
         relationshipStatus: String(ACTIVE/DELETED) (Optional)
     }
 ]
 
 

Parameters:

termId - The globally unique identifier for glossary term.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the response body along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

assignTermToEntitiesWithResponse

public com.azure.core.http.rest.Response<Void> assignTermToEntitiesWithResponse(String termId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. [Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.

Request Body Schema

 
 [
      (Required){
         guid: String (Optional)
         typeName: String (Optional)
         uniqueAttributes (Optional): {
             String: BinaryData (Required)
         }
         displayText: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         relationshipType: String (Optional)
         relationshipAttributes (Optional): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
         }
         relationshipGuid: String (Optional)
         relationshipStatus: String(ACTIVE/DELETED) (Optional)
     }
 ]
 
 

Parameters:

termId - The globally unique identifier for glossary term.

body - An array of related object IDs to which the term has to be associated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteTermAssignmentFromEntitiesWithResponse

public com.azure.core.http.rest.Response<Void> deleteTermAssignmentFromEntitiesWithResponse(String termId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Request Body Schema

 
 [
      (Required){
         guid: String (Optional)
         typeName: String (Optional)
         uniqueAttributes (Optional): {
             String: BinaryData (Required)
         }
         displayText: String (Optional)
         entityStatus: String(ACTIVE/DELETED) (Optional)
         relationshipType: String (Optional)
         relationshipAttributes (Optional): {
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
         }
         relationshipGuid: String (Optional)
         relationshipStatus: String(ACTIVE/DELETED) (Optional)
     }
 ]
 
 

Parameters:

termId - The globally unique identifier for glossary term.

body - An array of related object IDs from which the term has to be dissociated.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getRelatedTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getRelatedTermsWithResponse(String termId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 {
     String (Required): [
          (Required){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
 }
 
 

Parameters:

termId - The globally unique identifier for glossary term.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

all related terms for a specific term by its GUID along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

Get a specific Glossary by its GUID.

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a specific Glossary by its GUID along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateWithResponse(String glossaryId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary.

Query Parameters

Query Parameters

Name	Type	Required	Description
ignoreTermsAndCategories	Boolean	No	Whether ignore terms and categories

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

body - Body parameter.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary object along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteWithResponse

public com.azure.core.http.rest.Response<Void> deleteWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getCategoriesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCategoriesWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         childrenCategories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 parentCategoryGuid: String (Optional)
                 relationGuid: String (Optional)
             }
         ]
         parentCategory (Optional): (recursive schema, see parentCategory above)
         terms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
     }
 ]
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the categories belonging to a specific glossary along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getCategoriesHeadersWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getCategoriesHeadersWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         categoryGuid: String (Optional)
         description: String (Optional)
         displayText: String (Optional)
         parentCategoryGuid: String (Optional)
         relationGuid: String (Optional)
     }
 ]
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the category headers belonging to a specific glossary along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getDetailedWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getDetailedWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
     categoryInfo (Optional): {
         String (Required): {
             guid: String (Optional)
             classifications (Optional): [
                 (recursive schema, see above)
             ]
             longDescription: String (Optional)
             name: String (Optional)
             qualifiedName: String (Optional)
             shortDescription: String (Optional)
             lastModifiedTS: String (Optional)
             createTime: Long (Optional)
             createdBy: String (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             anchor (Optional): {
                 displayText: String (Optional)
                 glossaryGuid: String (Optional)
                 relationGuid: String (Optional)
             }
             childrenCategories (Optional): [
                 (recursive schema, see above)
             ]
             parentCategory (Optional): (recursive schema, see parentCategory above)
             terms (Optional): [
                 (recursive schema, see above)
             ]
         }
     }
     termInfo (Optional): {
         String (Required): {
             guid: String (Optional)
             classifications (Optional): [
                 (recursive schema, see above)
             ]
             longDescription: String (Optional)
             name: String (Optional)
             qualifiedName: String (Optional)
             shortDescription: String (Optional)
             lastModifiedTS: String (Optional)
             createTime: Long (Optional)
             createdBy: String (Optional)
             updateTime: Long (Optional)
             updatedBy: String (Optional)
             abbreviation: String (Optional)
             templateName (Optional): [
                 BinaryData (Optional)
             ]
             anchor (Optional): (recursive schema, see anchor above)
             antonyms (Optional): [
                 (recursive schema, see above)
             ]
             status: String(Draft/Approved/Alert/Expired) (Optional)
             nickName: String (Optional)
             hierarchyInfo (Optional): [
                  (Optional){
                     guid: String (Optional)
                     typeName: String (Optional)
                     uniqueAttributes (Optional): {
                         String: BinaryData (Required)
                     }
                     name: String (Optional)
                     displayText: String (Optional)
                     itemPath: String (Optional)
                     resourceId: String (Optional)
                     properties (Optional): {
                         String: BinaryData (Required)
                     }
                 }
             ]
             resources (Optional): [
                  (Optional){
                     displayName: String (Optional)
                     url: String (Optional)
                 }
             ]
             contacts (Optional): {
                 String (Required): [
                      (Required){
                         id: String (Optional)
                         info: String (Optional)
                     }
                 ]
             }
             attributes (Optional): {
                 String (Required): {
                     String: BinaryData (Required)
                 }
             }
             assignedEntities (Optional): [
                  (Optional){
                     guid: String (Optional)
                     typeName: String (Optional)
                     uniqueAttributes (Optional): {
                         String: BinaryData (Required)
                     }
                     displayText: String (Optional)
                     entityStatus: String(ACTIVE/DELETED) (Optional)
                     relationshipType: String (Optional)
                     relationshipAttributes (Optional): {
                         attributes (Optional): {
                             String: BinaryData (Required)
                         }
                         typeName: String (Optional)
                         lastModifiedTS: String (Optional)
                     }
                     relationshipGuid: String (Optional)
                     relationshipStatus: String(ACTIVE/DELETED) (Optional)
                 }
             ]
             categories (Optional): [
                  (Optional){
                     categoryGuid: String (Optional)
                     description: String (Optional)
                     displayText: String (Optional)
                     relationGuid: String (Optional)
                     status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 }
             ]
             classifies (Optional): [
                 (recursive schema, see above)
             ]
             examples (Optional): [
                 String (Optional)
             ]
             isA (Optional): [
                 (recursive schema, see above)
             ]
             preferredTerms (Optional): [
                 (recursive schema, see above)
             ]
             preferredToTerms (Optional): [
                 (recursive schema, see above)
             ]
             replacedBy (Optional): [
                 (recursive schema, see above)
             ]
             replacementTerms (Optional): [
                 (recursive schema, see above)
             ]
             seeAlso (Optional): [
                 (recursive schema, see above)
             ]
             synonyms (Optional): [
                 (recursive schema, see above)
             ]
             translatedTerms (Optional): [
                 (recursive schema, see above)
             ]
             translationTerms (Optional): [
                 (recursive schema, see above)
             ]
             usage: String (Optional)
             validValues (Optional): [
                 (recursive schema, see above)
             ]
             validValuesFor (Optional): [
                 (recursive schema, see above)
             ]
         }
     }
 }
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

a specific glossary with detailed information along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

partialUpdateWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateWithResponse(String glossaryId,
 com.azure.core.util.BinaryData body,
 com.azure.core.http.rest.RequestOptions requestOptions)

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.

Query Parameters

Query Parameters

Name	Type	Required	Description
ignoreTermsAndCategories	Boolean	No	Whether ignore terms and categories

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Request Body Schema

 
 {
     String: String (Required)
 }
 
 

Response Body Schema

 
 {
     guid: String (Optional)
     classifications (Optional): [
          (Optional){
             attributes (Optional): {
                 String: BinaryData (Required)
             }
             typeName: String (Optional)
             lastModifiedTS: String (Optional)
             entityGuid: String (Optional)
             entityStatus: String(ACTIVE/DELETED) (Optional)
             removePropagationsOnEntityDelete: Boolean (Optional)
             validityPeriods (Optional): [
                  (Optional){
                     endTime: String (Optional)
                     startTime: String (Optional)
                     timeZone: String (Optional)
                 }
             ]
         }
     ]
     longDescription: String (Optional)
     name: String (Optional)
     qualifiedName: String (Optional)
     shortDescription: String (Optional)
     lastModifiedTS: String (Optional)
     createTime: Long (Optional)
     createdBy: String (Optional)
     updateTime: Long (Optional)
     updatedBy: String (Optional)
     categories (Optional): [
          (Optional){
             categoryGuid: String (Optional)
             description: String (Optional)
             displayText: String (Optional)
             parentCategoryGuid: String (Optional)
             relationGuid: String (Optional)
         }
     ]
     language: String (Optional)
     terms (Optional): [
          (Optional){
             description: String (Optional)
             displayText: String (Optional)
             expression: String (Optional)
             relationGuid: String (Optional)
             status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             steward: String (Optional)
             termGuid: String (Optional)
         }
     ]
     usage: String (Optional)
 }
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

body - A map containing keys as attribute names and values as corresponding attribute values.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

the glossary object along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTermsWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         guid: String (Optional)
         classifications (Optional): [
              (Optional){
                 attributes (Optional): {
                     String: BinaryData (Required)
                 }
                 typeName: String (Optional)
                 lastModifiedTS: String (Optional)
                 entityGuid: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 removePropagationsOnEntityDelete: Boolean (Optional)
                 validityPeriods (Optional): [
                      (Optional){
                         endTime: String (Optional)
                         startTime: String (Optional)
                         timeZone: String (Optional)
                     }
                 ]
             }
         ]
         longDescription: String (Optional)
         name: String (Optional)
         qualifiedName: String (Optional)
         shortDescription: String (Optional)
         lastModifiedTS: String (Optional)
         createTime: Long (Optional)
         createdBy: String (Optional)
         updateTime: Long (Optional)
         updatedBy: String (Optional)
         abbreviation: String (Optional)
         templateName (Optional): [
             BinaryData (Optional)
         ]
         anchor (Optional): {
             displayText: String (Optional)
             glossaryGuid: String (Optional)
             relationGuid: String (Optional)
         }
         antonyms (Optional): [
              (Optional){
                 description: String (Optional)
                 displayText: String (Optional)
                 expression: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
                 steward: String (Optional)
                 termGuid: String (Optional)
             }
         ]
         status: String(Draft/Approved/Alert/Expired) (Optional)
         nickName: String (Optional)
         hierarchyInfo (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 name: String (Optional)
                 displayText: String (Optional)
                 itemPath: String (Optional)
                 resourceId: String (Optional)
                 properties (Optional): {
                     String: BinaryData (Required)
                 }
             }
         ]
         resources (Optional): [
              (Optional){
                 displayName: String (Optional)
                 url: String (Optional)
             }
         ]
         contacts (Optional): {
             String (Required): [
                  (Required){
                     id: String (Optional)
                     info: String (Optional)
                 }
             ]
         }
         attributes (Optional): {
             String (Required): {
                 String: BinaryData (Required)
             }
         }
         assignedEntities (Optional): [
              (Optional){
                 guid: String (Optional)
                 typeName: String (Optional)
                 uniqueAttributes (Optional): {
                     String: BinaryData (Required)
                 }
                 displayText: String (Optional)
                 entityStatus: String(ACTIVE/DELETED) (Optional)
                 relationshipType: String (Optional)
                 relationshipAttributes (Optional): {
                     attributes (Optional): {
                         String: BinaryData (Required)
                     }
                     typeName: String (Optional)
                     lastModifiedTS: String (Optional)
                 }
                 relationshipGuid: String (Optional)
                 relationshipStatus: String(ACTIVE/DELETED) (Optional)
             }
         ]
         categories (Optional): [
              (Optional){
                 categoryGuid: String (Optional)
                 description: String (Optional)
                 displayText: String (Optional)
                 relationGuid: String (Optional)
                 status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
             }
         ]
         classifies (Optional): [
             (recursive schema, see above)
         ]
         examples (Optional): [
             String (Optional)
         ]
         isA (Optional): [
             (recursive schema, see above)
         ]
         preferredTerms (Optional): [
             (recursive schema, see above)
         ]
         preferredToTerms (Optional): [
             (recursive schema, see above)
         ]
         replacedBy (Optional): [
             (recursive schema, see above)
         ]
         replacementTerms (Optional): [
             (recursive schema, see above)
         ]
         seeAlso (Optional): [
             (recursive schema, see above)
         ]
         synonyms (Optional): [
             (recursive schema, see above)
         ]
         translatedTerms (Optional): [
             (recursive schema, see above)
         ]
         translationTerms (Optional): [
             (recursive schema, see above)
         ]
         usage: String (Optional)
         validValues (Optional): [
             (recursive schema, see above)
         ]
         validValuesFor (Optional): [
             (recursive schema, see above)
         ]
     }
 ]
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

terms belonging to a specific glossary along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTermHeadersWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getTermHeadersWithResponse(String glossaryId,
 com.azure.core.http.rest.RequestOptions requestOptions)

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

Query Parameters

Query Parameters

Name	Type	Required	Description
limit	Integer	No	The page size - by default there is no paging.
offset	Integer	No	The offset for pagination purpose.
sort	String	No	The sort order, ASC (default) or DESC.

You can add these to a request with RequestOptions.addQueryParam(java.lang.String, java.lang.String)

Response Body Schema

 
 [
      (Required){
         description: String (Optional)
         displayText: String (Optional)
         expression: String (Optional)
         relationGuid: String (Optional)
         status: String(DRAFT/ACTIVE/DEPRECATED/OBSOLETE/OTHER) (Optional)
         steward: String (Optional)
         termGuid: String (Optional)
     }
 ]
 
 

Parameters:

glossaryId - The globally unique identifier for glossary.

requestOptions - The options to configure the HTTP request before HTTP client sends it.

Returns:

term headers belonging to a specific glossary along with Response.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

batchGet

public List<AtlasGlossary> batchGet(Integer limit,
 Integer offset,
 String sort,
 Boolean 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'.

Parameters:

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

ignoreTermsAndCategories - Whether ignore terms and categories.

Returns:

all glossaries.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

batchGet

public List<AtlasGlossary> batchGet()

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

Returns:

all glossaries.

Throws:

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

create

public AtlasGlossary create(AtlasGlossary body)

Create a glossary.

Parameters:

body - Body parameter.

Returns:

the glossary object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createCategories

public List<AtlasGlossaryCategory> createCategories(List<AtlasGlossaryCategory> body)

Create glossary category in bulk.

Parameters:

body - An array of glossary category definitions to be created.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createCategory

public AtlasGlossaryCategory createCategory(AtlasGlossaryCategory body)

Create a glossary category.

Parameters:

body - Body parameter.

Returns:

the glossary category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategory

public AtlasGlossaryCategory getCategory(String categoryId)

Get specific glossary category by its GUID.

Parameters:

categoryId - The globally unique identifier of the category.

Returns:

specific glossary category by its GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateCategory

public AtlasGlossaryCategory updateCategory(String categoryId,
 AtlasGlossaryCategory body)

Update the given glossary category by its GUID.

Parameters:

categoryId - The globally unique identifier of the category.

body - Body parameter.

Returns:

the glossary category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteCategory

public void deleteCategory(String categoryId)

Delete a glossary category.

Parameters:

categoryId - The globally unique identifier of the category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

partialUpdateCategory

public AtlasGlossaryCategory partialUpdateCategory(String categoryId,
 Map<String,String> body)

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

Parameters:

categoryId - The globally unique identifier of the category.

body - A map containing keys as attribute names and values as corresponding attribute values for partial update.

Returns:

the glossary category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRelatedCategories

public Map<String,List<AtlasRelatedCategoryHeader>> getRelatedCategories(String categoryId,
 Integer limit,
 Integer offset,
 String 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.

Parameters:

categoryId - The globally unique identifier of the category.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

all related categories (parent and children).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRelatedCategories

public Map<String,List<AtlasRelatedCategoryHeader>> getRelatedCategories(String categoryId)

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.

Parameters:

categoryId - The globally unique identifier of the category.

Returns:

all related categories (parent and children).

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategoryTerms

public List<AtlasRelatedTermHeader> getCategoryTerms(String categoryId,
 Integer limit,
 Integer offset,
 String sort)

Get all terms associated with the specific category.

Parameters:

categoryId - The globally unique identifier of the category.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

all terms associated with the specific category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategoryTerms

public List<AtlasRelatedTermHeader> getCategoryTerms(String categoryId)

Get all terms associated with the specific category.

Parameters:

categoryId - The globally unique identifier of the category.

Returns:

all terms associated with the specific category.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createTerm

public AtlasGlossaryTerm createTerm(AtlasGlossaryTerm body,
 Boolean includeTermHierarchy)

Create a glossary term.

Parameters:

body - Body parameter.

includeTermHierarchy - Whether include term hierarchy.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createTerm

public AtlasGlossaryTerm createTerm(AtlasGlossaryTerm body)

Create a glossary term.

Parameters:

body - Body parameter.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getTerm

public AtlasGlossaryTerm getTerm(String termId)

Get a specific glossary term by its GUID.

Parameters:

termId - The globally unique identifier for glossary term.

Returns:

a specific glossary term by its GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTerm

public AtlasGlossaryTerm updateTerm(String termId,
 AtlasGlossaryTerm body,
 Boolean includeTermHierarchy)

Update the given glossary term by its GUID.

Parameters:

termId - The globally unique identifier for glossary term.

body - Body parameter.

includeTermHierarchy - Whether include term hierarchy.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

updateTerm

public AtlasGlossaryTerm updateTerm(String termId,
 AtlasGlossaryTerm body)

Update the given glossary term by its GUID.

Parameters:

termId - The globally unique identifier for glossary term.

body - Body parameter.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteTerm

public void deleteTerm(String termId)

Delete a glossary term.

Parameters:

termId - The globally unique identifier for glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

partialUpdateTerm

public AtlasGlossaryTerm partialUpdateTerm(String termId,
 Map<String,String> body,
 Boolean includeTermHierarchy)

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

Parameters:

termId - The globally unique identifier for glossary term.

body - A map containing keys as attribute names and values as corresponding attribute values to be updated.

includeTermHierarchy - Whether include term hierarchy.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

partialUpdateTerm

public AtlasGlossaryTerm partialUpdateTerm(String termId,
 Map<String,String> body)

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

Parameters:

termId - The globally unique identifier for glossary term.

body - A map containing keys as attribute names and values as corresponding attribute values to be updated.

Returns:

the glossary term.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createTerms

public List<AtlasGlossaryTerm> createTerms(List<AtlasGlossaryTerm> body,
 Boolean includeTermHierarchy)

Create glossary terms in bulk.

Parameters:

body - An array of glossary term definitions to be created in bulk.

includeTermHierarchy - Whether include term hierarchy.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

createTerms

public List<AtlasGlossaryTerm> createTerms(List<AtlasGlossaryTerm> body)

Create glossary terms in bulk.

Parameters:

body - An array of glossary term definitions to be created in bulk.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntitiesAssignedWithTerm

public List<AtlasRelatedObjectId> getEntitiesAssignedWithTerm(String termId,
 Integer limit,
 Integer offset,
 String sort)

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

Parameters:

termId - The globally unique identifier for glossary term.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getEntitiesAssignedWithTerm

public List<AtlasRelatedObjectId> getEntitiesAssignedWithTerm(String termId)

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

Parameters:

termId - The globally unique identifier for glossary term.

Returns:

the response.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

assignTermToEntities

public void assignTermToEntities(String termId,
 List<AtlasRelatedObjectId> body)

Assign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. [Entities Create Or Update operation](https://learn.microsoft.com/en-us/rest/api/purview/datamapdataplane/entity/bulk-create-or-update?tabs=HTTP) is an alternative to assign a term to multiple entities.

Parameters:

termId - The globally unique identifier for glossary term.

body - An array of related object IDs to which the term has to be associated.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

deleteTermAssignmentFromEntities

public void deleteTermAssignmentFromEntities(String termId,
 List<AtlasRelatedObjectId> body)

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

Parameters:

termId - The globally unique identifier for glossary term.

body - An array of related object IDs from which the term has to be dissociated.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRelatedTerms

public Map<String,List<AtlasRelatedTermHeader>> getRelatedTerms(String termId,
 Integer limit,
 Integer offset,
 String 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.

Parameters:

termId - The globally unique identifier for glossary term.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

all related terms for a specific term by its GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getRelatedTerms

public Map<String,List<AtlasRelatedTermHeader>> getRelatedTerms(String termId)

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.

Parameters:

termId - The globally unique identifier for glossary term.

Returns:

all related terms for a specific term by its GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

get

public AtlasGlossary get(String glossaryId)

Get a specific Glossary by its GUID.

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

a specific Glossary by its GUID.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

public AtlasGlossary update(String glossaryId,
 AtlasGlossary body,
 Boolean ignoreTermsAndCategories)

Update the given glossary.

Parameters:

glossaryId - The globally unique identifier for glossary.

body - Body parameter.

ignoreTermsAndCategories - Whether ignore terms and categories.

Returns:

the glossary object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

update

public AtlasGlossary update(String glossaryId,
 AtlasGlossary body)

Update the given glossary.

Parameters:

glossaryId - The globally unique identifier for glossary.

body - Body parameter.

Returns:

the glossary object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

delete

public void delete(String glossaryId)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategories

public List<AtlasGlossaryCategory> getCategories(String glossaryId,
 Integer limit,
 Integer offset,
 String sort)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

the categories belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategories

public List<AtlasGlossaryCategory> getCategories(String glossaryId)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

the categories belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategoriesHeaders

public List<AtlasRelatedCategoryHeader> getCategoriesHeaders(String glossaryId,
 Integer limit,
 Integer offset,
 String sort)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

the category headers belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getCategoriesHeaders

public List<AtlasRelatedCategoryHeader> getCategoriesHeaders(String glossaryId)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

the category headers belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getDetailed

public AtlasGlossaryExtInfo getDetailed(String glossaryId)

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.

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

a specific glossary with detailed information.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

partialUpdate

public AtlasGlossary partialUpdate(String glossaryId,
 Map<String,String> body,
 Boolean 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:

glossaryId - The globally unique identifier for glossary.

body - A map containing keys as attribute names and values as corresponding attribute values.

ignoreTermsAndCategories - Whether ignore terms and categories.

Returns:

the glossary object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

partialUpdate

public AtlasGlossary partialUpdate(String glossaryId,
 Map<String,String> body)

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:

glossaryId - The globally unique identifier for glossary.

body - A map containing keys as attribute names and values as corresponding attribute values.

Returns:

the glossary object.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getTerms

public List<AtlasGlossaryTerm> getTerms(String glossaryId,
 Integer limit,
 Integer offset,
 String sort)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

terms belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getTerms

public List<AtlasGlossaryTerm> getTerms(String glossaryId)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

terms belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getTermHeaders

public List<AtlasRelatedTermHeader> getTermHeaders(String glossaryId,
 Integer limit,
 Integer offset,
 String sort)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

limit - The page size - by default there is no paging.

offset - The offset for pagination purpose.

sort - The sort order, ASC (default) or DESC.

Returns:

term headers belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

getTermHeaders

public List<AtlasRelatedTermHeader> getTermHeaders(String glossaryId)

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

Parameters:

glossaryId - The globally unique identifier for glossary.

Returns:

term headers belonging to a specific glossary.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.exception.HttpResponseException - thrown if the request is rejected by server.

com.azure.core.exception.ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

com.azure.core.exception.ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

com.azure.core.exception.ResourceModifiedException - thrown if the request is rejected by server on status code 409.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.