com.azure.analytics.purview.catalog.GlossaryClient

public final class GlossaryClient extends Object

Initializes a new instance of the synchronous PurviewCatalogClient type.

Method Summary

Modifier and Type

Method

Description

com.azure.core.http.rest.Response<Void>

assignTermToEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)

Assign the given term to the provided list of related objects.

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginImportGlossaryTermsViaCsv(String glossaryGuid, com.azure.core.util.BinaryData file, com.azure.core.http.rest.RequestOptions requestOptions)

Import Glossary Terms from local csv file.

com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData>

beginImportGlossaryTermsViaCsvByGlossaryName(String glossaryName, com.azure.core.util.BinaryData file, com.azure.core.http.rest.RequestOptions requestOptions)

Import Glossary Terms from local csv file by glossaryName.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createGlossaryCategoriesWithResponse(com.azure.core.util.BinaryData glossaryCategory, com.azure.core.http.rest.RequestOptions requestOptions)

Create glossary category in bulk.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createGlossaryCategoryWithResponse(com.azure.core.util.BinaryData glossaryCategory, com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary category.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createGlossaryTermsWithResponse(com.azure.core.util.BinaryData glossaryTerm, com.azure.core.http.rest.RequestOptions requestOptions)

Create glossary terms in bulk.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createGlossaryTermWithResponse(com.azure.core.util.BinaryData glossaryTerm, com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary term.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

createGlossaryWithResponse(com.azure.core.util.BinaryData atlasGlossary, com.azure.core.http.rest.RequestOptions requestOptions)

Create a glossary.

com.azure.core.http.rest.Response<Void>

deleteGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Delete a glossary category.

com.azure.core.http.rest.Response<Void>

deleteGlossaryTermWithResponse(String termGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Delete a glossary term.

com.azure.core.http.rest.Response<Void>

deleteGlossaryWithResponse(String glossaryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Delete a glossary.

com.azure.core.http.rest.Response<Void>

deleteTermAssignmentFromEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)

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

com.azure.core.http.rest.Response<Flux<ByteBuffer>>

exportGlossaryTermsAsCsvWithResponse(String glossaryGuid, com.azure.core.util.BinaryData termGuids, com.azure.core.http.rest.RequestOptions requestOptions)

Export Glossary Terms as csv file.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getDetailedGlossaryWithResponse(String glossaryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get a specific glossary with detailed information.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getEntitiesAssignedWithTermWithResponse(String termGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get all related objects assigned with the specified term.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get specific glossary category by its GUID.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getGlossaryTermWithResponse(String termGuid, 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>

getGlossaryWithResponse(String glossaryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get a specific Glossary by its GUID.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

getImportCsvOperationStatusWithResponse(String operationGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get the status of import csv operation.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listCategoryTermsWithResponse(String categoryGuid, 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>

listGlossariesWithResponse(com.azure.core.http.rest.RequestOptions requestOptions)

Get all glossaries registered with Atlas.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listGlossaryCategoriesHeadersWithResponse(String glossaryGuid, 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>

listGlossaryCategoriesWithResponse(String glossaryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get the categories belonging to a specific glossary.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listGlossaryTermHeadersWithResponse(String glossaryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get term headers belonging to a specific glossary.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listGlossaryTermsWithResponse(String glossaryGuid, 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>

listRelatedCategoriesWithResponse(String categoryGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get all related categories (parent and children).

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listRelatedTermsWithResponse(String termGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get all related terms for a specific term by its GUID.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

listTermsByGlossaryNameWithResponse(String glossaryName, com.azure.core.http.rest.RequestOptions requestOptions)

Get terms by glossary name.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

partialUpdateGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary category partially.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

partialUpdateGlossaryTermWithResponse(String termGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary term partially.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

partialUpdateGlossaryWithResponse(String glossaryGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary partially.

com.azure.core.http.rest.Response<Void>

removeTermAssignmentFromEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)

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

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

updateGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.util.BinaryData glossaryCategory, com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary category by its GUID.

com.azure.core.http.rest.Response<com.azure.core.util.BinaryData>

updateGlossaryTermWithResponse(String termGuid, com.azure.core.util.BinaryData glossaryTerm, 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>

updateGlossaryWithResponse(String glossaryGuid, com.azure.core.util.BinaryData updatedGlossary, 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

listGlossariesWithResponse

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

Get all glossaries registered with Atlas.

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

Response Body Schema


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

Parameters:: requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: all glossaries registered with Atlas 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.

createGlossaryWithResponse

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

Create a glossary.

Request Body Schema


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

Response Body Schema


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

Parameters:: atlasGlossary - Glossary definition, terms & categories can be anchored to a glossary. Using the anchor attribute when creating the Term/Category.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossary 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.

createGlossaryCategoriesWithResponse

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

Create glossary category in bulk.

Request Body Schema


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

Response Body Schema


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

Parameters:: glossaryCategory - An array of glossary category definitions to be created.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: an array of glossary category created successfully in bulk 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.

createGlossaryCategoryWithResponse

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

Create a glossary category.

Request Body Schema


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

Response Body Schema


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

Parameters:: glossaryCategory - The glossary category definition. A category must be anchored to a Glossary when creating. Optionally, terms belonging to the category and the hierarchy can also be defined during creation.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossaryCategory 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.

getGlossaryCategoryWithResponse

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

Get specific glossary category by its GUID.

Response Body Schema


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

Parameters:: categoryGuid - 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.

updateGlossaryCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.util.BinaryData glossaryCategory, com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary category by its GUID.

Request Body Schema


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

Response Body Schema


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

Parameters:: categoryGuid - The globally unique identifier of the category.; glossaryCategory - The glossary category to be updated.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossaryCategory 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.

deleteGlossaryCategoryWithResponse

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

Delete a glossary category.

Parameters:

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

partialUpdateGlossaryCategoryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateGlossaryCategoryWithResponse(String categoryGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary category partially.

Request Body Schema


 {
     String: String
 }

Response Body Schema


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

Parameters:: categoryGuid - The globally unique identifier of the category.; partialUpdates - 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:: atlasGlossaryCategory 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.

listRelatedCategoriesWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listRelatedCategoriesWithResponse(String categoryGuid, 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.

Response Body Schema


 {
     String: [
         {
             categoryGuid: String
             description: String
             displayText: String
             parentCategoryGuid: String
             relationGuid: String
         }
     ]
 }

Parameters:: categoryGuid - 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.

listCategoryTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listCategoryTermsWithResponse(String categoryGuid, 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.

Response Body Schema


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

Parameters:: categoryGuid - 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.

createGlossaryTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createGlossaryTermWithResponse(com.azure.core.util.BinaryData glossaryTerm, 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

Request Body Schema


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

Response Body Schema


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

Parameters:: glossaryTerm - The glossary term definition. A term must be anchored to a Glossary at the time of creation. Optionally it can be categorized as well.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossaryTerm 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.

getGlossaryTermWithResponse

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

Get a specific glossary term by its GUID.

Query Parameters

Query Parameters
Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy
excludeRelationshipTypes	List<String>	No	An array of relationship types which need to be excluded. Call `RequestOptions.addQueryParam(java.lang.String, java.lang.String)` to add string to array.

Response Body Schema


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

Parameters:: termGuid - 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.

updateGlossaryTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateGlossaryTermWithResponse(String termGuid, com.azure.core.util.BinaryData glossaryTerm, 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

Request Body Schema


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

Response Body Schema


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

Parameters:: termGuid - The globally unique identifier for glossary term.; glossaryTerm - The glossary term to be updated.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossaryTerm 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.

deleteGlossaryTermWithResponse

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

Delete a glossary term.

Parameters:

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

partialUpdateGlossaryTermWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateGlossaryTermWithResponse(String termGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary term partially.

Query Parameters

Query Parameters
Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

Request Body Schema


 {
     String: String
 }

Response Body Schema


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

Parameters:: termGuid - The globally unique identifier for glossary term.; partialUpdates - 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:: atlasGlossaryTerm 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.

createGlossaryTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> createGlossaryTermsWithResponse(com.azure.core.util.BinaryData glossaryTerm, 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

Request Body Schema


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

Response Body Schema


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

Parameters:: glossaryTerm - 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:: if bulk glossary terms creation was successful 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 termGuid, com.azure.core.http.rest.RequestOptions requestOptions)

Get all related objects assigned with the specified term.

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.

Response Body Schema


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

Parameters:: termGuid - The globally unique identifier for glossary term.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: all related objects assigned with the specified 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.

assignTermToEntitiesWithResponse

public com.azure.core.http.rest.Response<Void> assignTermToEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)
Assign the given term to the provided list of related objects.
Request Body Schema
```
 [
     {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
         displayText: String
         entityStatus: String(ACTIVE/DELETED)
         relationshipType: String
         relationshipAttributes: {
             attributes: {
                 String: Object
             }
             typeName: String
             lastModifiedTS: String
         }
         relationshipGuid: String
         relationshipStatus: String(ACTIVE/DELETED)
     }
 ]
 
```
Parameters:

termGuid - The globally unique identifier for glossary term.

relatedObjectIds - 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.
removeTermAssignmentFromEntitiesWithResponse

public com.azure.core.http.rest.Response<Void> removeTermAssignmentFromEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)
Delete the term assignment for the given list of related objects.
Request Body Schema
```
 [
     {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
         displayText: String
         entityStatus: String(ACTIVE/DELETED)
         relationshipType: String
         relationshipAttributes: {
             attributes: {
                 String: Object
             }
             typeName: String
             lastModifiedTS: String
         }
         relationshipGuid: String
         relationshipStatus: String(ACTIVE/DELETED)
     }
 ]
 
```
Parameters:

termGuid - The globally unique identifier for glossary term.

relatedObjectIds - 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.
deleteTermAssignmentFromEntitiesWithResponse

public com.azure.core.http.rest.Response<Void> deleteTermAssignmentFromEntitiesWithResponse(String termGuid, com.azure.core.util.BinaryData relatedObjectIds, com.azure.core.http.rest.RequestOptions requestOptions)
Delete the term assignment for the given list of related objects.
Request Body Schema
```
 [
     {
         guid: String
         typeName: String
         uniqueAttributes: {
             String: Object
         }
         displayText: String
         entityStatus: String(ACTIVE/DELETED)
         relationshipType: String
         relationshipAttributes: {
             attributes: {
                 String: Object
             }
             typeName: String
             lastModifiedTS: String
         }
         relationshipGuid: String
         relationshipStatus: String(ACTIVE/DELETED)
     }
 ]
 
```
Parameters:

termGuid - The globally unique identifier for glossary term.

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

listRelatedTermsWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> listRelatedTermsWithResponse(String termGuid, 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.

Response Body Schema


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

Parameters:: termGuid - 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.

getGlossaryWithResponse

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

Get a specific Glossary by its GUID.

Response Body Schema


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

Parameters:: glossaryGuid - 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.

updateGlossaryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> updateGlossaryWithResponse(String glossaryGuid, com.azure.core.util.BinaryData updatedGlossary, com.azure.core.http.rest.RequestOptions requestOptions)

Update the given glossary.

Request Body Schema


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

Response Body Schema


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

Parameters:: glossaryGuid - The globally unique identifier for glossary.; updatedGlossary - The glossary definition to be updated.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: atlasGlossary 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.

deleteGlossaryWithResponse

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

Delete a glossary.

Parameters:

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

listGlossaryCategoriesWithResponse

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

Get the categories belonging to a specific glossary.

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.

Response Body Schema


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

Parameters:: glossaryGuid - 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.

listGlossaryCategoriesHeadersWithResponse

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

Get the category headers belonging to a specific glossary.

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.

Response Body Schema


 [
     {
         categoryGuid: String
         description: String
         displayText: String
         parentCategoryGuid: String
         relationGuid: String
     }
 ]

Parameters:: glossaryGuid - 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.

getDetailedGlossaryWithResponse

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

Get a specific glossary with detailed information.

Query Parameters

Query Parameters
Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

Response Body Schema


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

Parameters:: glossaryGuid - 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.

partialUpdateGlossaryWithResponse

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> partialUpdateGlossaryWithResponse(String glossaryGuid, com.azure.core.util.BinaryData partialUpdates, com.azure.core.http.rest.RequestOptions requestOptions)

Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated.

Query Parameters

Query Parameters
Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy

Request Body Schema


 {
     String: String
 }

Response Body Schema


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

Parameters:: glossaryGuid - The globally unique identifier for glossary.; partialUpdates - 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:: atlasGlossary 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.

listGlossaryTermsWithResponse

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

Get terms belonging to a specific glossary.

Query Parameters

Query Parameters
Name	Type	Required	Description
includeTermHierarchy	Boolean	No	Whether include term hierarchy
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.

Response Body Schema


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

Parameters:: glossaryGuid - 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.

listGlossaryTermHeadersWithResponse

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

Get term headers belonging to a specific glossary.

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.

Response Body Schema


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

Parameters:: glossaryGuid - 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.

beginImportGlossaryTermsViaCsv

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginImportGlossaryTermsViaCsv(String glossaryGuid, com.azure.core.util.BinaryData file, com.azure.core.http.rest.RequestOptions requestOptions)
Import Glossary Terms from local csv file.
Query Parameters
Query Parameters
Name Type Required Description

includeTermHierarchy Boolean No Whether include term hierarchy

Request Body Schema
```
 Flux<ByteBuffer>
 
```
Response Body Schema
```
 {
     id: String
     status: String(NotStarted/Succeeded/Failed/Running)
     createTime: String
     lastUpdateTime: String
     properties: {
         importedTerms: String
         totalTermsDetected: String
     }
     error: {
         errorCode: Integer
         errorMessage: String
     }
 }
 
```
Parameters:

glossaryGuid - The globally unique identifier for glossary.

file - The csv file to import glossary terms from.

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

Returns:

the SyncPoller for polling of status of import csv operation.

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

public com.azure.core.util.polling.SyncPoller<com.azure.core.util.BinaryData,com.azure.core.util.BinaryData> beginImportGlossaryTermsViaCsvByGlossaryName(String glossaryName, com.azure.core.util.BinaryData file, com.azure.core.http.rest.RequestOptions requestOptions)
Import Glossary Terms from local csv file by glossaryName.
Query Parameters
Query Parameters
Name Type Required Description

includeTermHierarchy Boolean No Whether include term hierarchy

Request Body Schema
```
 Flux<ByteBuffer>
 
```
Response Body Schema
```
 {
     id: String
     status: String(NotStarted/Succeeded/Failed/Running)
     createTime: String
     lastUpdateTime: String
     properties: {
         importedTerms: String
         totalTermsDetected: String
     }
     error: {
         errorCode: Integer
         errorMessage: String
     }
 }
 
```
Parameters:

glossaryName - The name of the glossary.

file - The csv file to import glossary terms from.

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

Returns:

the SyncPoller for polling of status of import csv operation.

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

public com.azure.core.http.rest.Response<com.azure.core.util.BinaryData> getImportCsvOperationStatusWithResponse(String operationGuid, com.azure.core.http.rest.RequestOptions requestOptions)
Get the status of import csv operation.
Response Body Schema
```
 {
     id: String
     status: String(NotStarted/Succeeded/Failed/Running)
     createTime: String
     lastUpdateTime: String
     properties: {
         importedTerms: String
         totalTermsDetected: String
     }
     error: {
         errorCode: Integer
         errorMessage: String
     }
 }
 
```
Parameters:

operationGuid - The globally unique identifier for async operation/job.

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

Returns:

the status of import csv operation 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.
exportGlossaryTermsAsCsvWithResponse

public com.azure.core.http.rest.Response<Flux<ByteBuffer>> exportGlossaryTermsAsCsvWithResponse(String glossaryGuid, com.azure.core.util.BinaryData termGuids, com.azure.core.http.rest.RequestOptions requestOptions)
Export Glossary Terms as csv file.
Query Parameters
Query Parameters
Name Type Required Description

includeTermHierarchy Boolean No Whether include term hierarchy

Request Body Schema
```
 [
     String
 ]
 
```
Response Body Schema
```
 Flux<ByteBuffer>
 
```
Parameters:

glossaryGuid - The globally unique identifier for glossary.

termGuids - An array of term guids.

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.

listTermsByGlossaryNameWithResponse

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

Get terms by glossary name.

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.
includeTermHierarchy	Boolean	No	Whether include term hierarchy

Response Body Schema


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

Parameters:: glossaryName - The name of the glossary.; requestOptions - The options to configure the HTTP request before HTTP client sends it.
Returns:: terms by glossary name 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.

Class GlossaryClient

Method Summary

Methods inherited from class java.lang.Object

Method Details

listGlossariesWithResponse

createGlossaryWithResponse

createGlossaryCategoriesWithResponse

createGlossaryCategoryWithResponse

getGlossaryCategoryWithResponse

updateGlossaryCategoryWithResponse

deleteGlossaryCategoryWithResponse

partialUpdateGlossaryCategoryWithResponse

listRelatedCategoriesWithResponse

listCategoryTermsWithResponse

createGlossaryTermWithResponse

getGlossaryTermWithResponse

updateGlossaryTermWithResponse

deleteGlossaryTermWithResponse

partialUpdateGlossaryTermWithResponse

createGlossaryTermsWithResponse

getEntitiesAssignedWithTermWithResponse

assignTermToEntitiesWithResponse

removeTermAssignmentFromEntitiesWithResponse

deleteTermAssignmentFromEntitiesWithResponse

listRelatedTermsWithResponse

getGlossaryWithResponse

updateGlossaryWithResponse

deleteGlossaryWithResponse

listGlossaryCategoriesWithResponse

listGlossaryCategoriesHeadersWithResponse

getDetailedGlossaryWithResponse

partialUpdateGlossaryWithResponse

listGlossaryTermsWithResponse

listGlossaryTermHeadersWithResponse

beginImportGlossaryTermsViaCsv

beginImportGlossaryTermsViaCsvByGlossaryName

getImportCsvOperationStatusWithResponse

exportGlossaryTermsAsCsvWithResponse

listTermsByGlossaryNameWithResponse