Package com.azure.analytics.purview.catalog

Class TypesClient

java.lang.Object

com.azure.analytics.purview.catalog.TypesClient

public final class TypesClient
extends Object

Initializes a new instance of the synchronous PurviewCatalogClient type.

Method Summary

Modifier and Type	Method	Description
Response<BinaryData>	createTypeDefinitionsWithResponse(BinaryData typesDef, RequestOptions requestOptions)	Create all atlas type definitions in bulk, only new definitions will be created.
Response<Void>	deleteTypeByNameWithResponse(String name, RequestOptions requestOptions)	Delete API for type identified by its name.
Response<Void>	deleteTypeDefinitionsWithResponse(BinaryData typesDef, RequestOptions requestOptions)	Delete API for all types in bulk.
Response<BinaryData>	getAllTypeDefinitionsWithResponse(RequestOptions requestOptions)	Get all type definitions in Atlas in bulk.
Response<BinaryData>	getBusinessMetadataDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the businessMetadata definition for the given guid.
Response<BinaryData>	getBusinessMetadataDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the businessMetadata definition by it's name (unique).
Response<BinaryData>	getClassificationDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the classification definition for the given GUID.
Response<BinaryData>	getClassificationDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the classification definition by its name (unique).
Response<BinaryData>	getEntityDefinitionByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the Entity definition for the given GUID.
Response<BinaryData>	getEntityDefinitionByNameWithResponse(String name, RequestOptions requestOptions)	Get the entity definition by its name (unique).
Response<BinaryData>	getEnumDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the enum definition for the given GUID.
Response<BinaryData>	getEnumDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the enum definition by its name (unique).
Response<BinaryData>	getRelationshipDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the relationship definition for the given GUID.
Response<BinaryData>	getRelationshipDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the relationship definition by its name (unique).
Response<BinaryData>	getStructDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the struct definition for the given GUID.
Response<BinaryData>	getStructDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the struct definition by its name (unique).
Response<BinaryData>	getTermTemplateDefByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the term template definition for the given GUID.
Response<BinaryData>	getTermTemplateDefByNameWithResponse(String name, RequestOptions requestOptions)	Get the term template definition by its name (unique).
Response<BinaryData>	getTypeDefinitionByGuidWithResponse(String guid, RequestOptions requestOptions)	Get the type definition for the given GUID.
Response<BinaryData>	getTypeDefinitionByNameWithResponse(String name, RequestOptions requestOptions)	Get the type definition by its name (unique).
Response<BinaryData>	listTypeDefinitionHeadersWithResponse(RequestOptions requestOptions)	List all type definitions returned as a list of minimal information header.
Response<BinaryData>	updateAtlasTypeDefinitionsWithResponse(BinaryData typesDef, RequestOptions requestOptions)	Update all types in bulk, changes detected in the type definitions would be persisted.

Methods inherited from class java.lang.Object

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

Method Details

getBusinessMetadataDefByGuidWithResponse

public Response<BinaryData> getBusinessMetadataDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the businessMetadata definition for the given guid.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

guid - businessMetadata guid.

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

Returns:

the businessMetadata definition for the given guid along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getBusinessMetadataDefByNameWithResponse

public Response<BinaryData> getBusinessMetadataDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the businessMetadata definition by it's name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

name - businessMetadata name.

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

Returns:

the businessMetadata definition by it's name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getClassificationDefByGuidWithResponse

public Response<BinaryData> getClassificationDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the classification definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     entityTypes: [
         String
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
 }
 

Parameters:

guid - The globally unique identifier of the classification.

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

Returns:

the classification definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getClassificationDefByNameWithResponse

public Response<BinaryData> getClassificationDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the classification definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     entityTypes: [
         String
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
 }
 

Parameters:

name - The name of the classification.

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

Returns:

the classification definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getEntityDefinitionByGuidWithResponse

public Response<BinaryData> getEntityDefinitionByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the Entity definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
     relationshipAttributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 (recursive schema, see above)
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
             isLegacyAttribute: Boolean
             relationshipTypeName: String
         }
     ]
 }
 

Parameters:

guid - The globally unique identifier of the entity.

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

Returns:

the Entity definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getEntityDefinitionByNameWithResponse

public Response<BinaryData> getEntityDefinitionByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the entity definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
     relationshipAttributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 (recursive schema, see above)
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
             isLegacyAttribute: Boolean
             relationshipTypeName: String
         }
     ]
 }
 

Parameters:

name - The name of the entity.

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

Returns:

the entity definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getEnumDefByGuidWithResponse

public Response<BinaryData> getEnumDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the enum definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     defaultValue: String
     elementDefs: [
         {
             description: String
             ordinal: Float
             value: String
         }
     ]
 }
 

Parameters:

guid - The globally unique identifier of the enum.

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

Returns:

the enum definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getEnumDefByNameWithResponse

public Response<BinaryData> getEnumDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the enum definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     defaultValue: String
     elementDefs: [
         {
             description: String
             ordinal: Float
             value: String
         }
     ]
 }
 

Parameters:

name - The name of the enum.

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

Returns:

the enum definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getRelationshipDefByGuidWithResponse

public Response<BinaryData> getRelationshipDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the relationship definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     endDef1: {
         cardinality: String(SINGLE/LIST/SET)
         description: String
         isContainer: Boolean
         isLegacyAttribute: Boolean
         name: String
         type: String
     }
     endDef2: (recursive schema, see endDef2 above)
     relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
     relationshipLabel: String
 }
 

Parameters:

guid - The globally unique identifier of the relationship.

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

Returns:

the relationship definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getRelationshipDefByNameWithResponse

public Response<BinaryData> getRelationshipDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the relationship definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
     endDef1: {
         cardinality: String(SINGLE/LIST/SET)
         description: String
         isContainer: Boolean
         isLegacyAttribute: Boolean
         name: String
         type: String
     }
     endDef2: (recursive schema, see endDef2 above)
     relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
     relationshipLabel: String
 }
 

Parameters:

name - The name of the relationship.

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

Returns:

the relationship definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getStructDefByGuidWithResponse

public Response<BinaryData> getStructDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the struct definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

guid - The globally unique identifier of the struct.

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

Returns:

the struct definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getStructDefByNameWithResponse

public Response<BinaryData> getStructDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the struct definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

name - The name of the struct.

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

Returns:

the struct definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTypeDefinitionByGuidWithResponse

public Response<BinaryData> getTypeDefinitionByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the type definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     entityTypes: [
         String
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
     relationshipAttributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
             isLegacyAttribute: Boolean
             relationshipTypeName: String
         }
     ]
     defaultValue: String
     elementDefs: [
         {
             description: String
             ordinal: Float
             value: String
         }
     ]
     endDef1: {
         cardinality: String(SINGLE/LIST/SET)
         description: String
         isContainer: Boolean
         isLegacyAttribute: Boolean
         name: String
         type: String
     }
     endDef2: (recursive schema, see endDef2 above)
     relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
     relationshipLabel: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 (recursive schema, see above)
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

guid - The globally unique identifier of the type.

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

Returns:

the type definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTypeDefinitionByNameWithResponse

public Response<BinaryData> getTypeDefinitionByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the type definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     entityTypes: [
         String
     ]
     subTypes: [
         String
     ]
     superTypes: [
         String
     ]
     relationshipAttributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
             isLegacyAttribute: Boolean
             relationshipTypeName: String
         }
     ]
     defaultValue: String
     elementDefs: [
         {
             description: String
             ordinal: Float
             value: String
         }
     ]
     endDef1: {
         cardinality: String(SINGLE/LIST/SET)
         description: String
         isContainer: Boolean
         isLegacyAttribute: Boolean
         name: String
         type: String
     }
     endDef2: (recursive schema, see endDef2 above)
     relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
     relationshipLabel: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 (recursive schema, see above)
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

name - The name of the type.

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

Returns:

the type definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteTypeByNameWithResponse

public Response<Void> deleteTypeByNameWithResponse(String name,
 RequestOptions requestOptions)

Delete API for type identified by its name.

Parameters:

name - The name of the type.

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

Returns:

the Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getAllTypeDefinitionsWithResponse

public Response<BinaryData> getAllTypeDefinitionsWithResponse(RequestOptions requestOptions)

Get all type definitions in Atlas in bulk.

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermTemplate	Boolean	No	Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template
type	String	No	Typedef name as search filter when get typedefs. Allowed values: enum, entity, classification, relationship, struct, term_template.

Response Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Parameters:

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

Returns:

all type definitions in Atlas in bulk along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

createTypeDefinitionsWithResponse

public Response<BinaryData> createTypeDefinitionsWithResponse(BinaryData typesDef,
 RequestOptions requestOptions)

Create all atlas type definitions in bulk, only new definitions will be created. Any changes to the existing definitions will be discarded.

Request Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Response Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Parameters:

typesDef - A composite wrapper object with corresponding lists of the type definition.

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

Returns:

atlasTypesDef along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

updateAtlasTypeDefinitionsWithResponse

public Response<BinaryData> updateAtlasTypeDefinitionsWithResponse(BinaryData typesDef,
 RequestOptions requestOptions)

Update all types in bulk, changes detected in the type definitions would be persisted.

Request Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Response Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Parameters:

typesDef - A composite object that captures all type definition changes.

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

Returns:

atlasTypesDef along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

deleteTypeDefinitionsWithResponse

public Response<Void> deleteTypeDefinitionsWithResponse(BinaryData typesDef,
 RequestOptions requestOptions)

Delete API for all types in bulk.

Request Body Schema

 {
     businessMetadataDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: {
                 availableLocales: [
                     String
                 ]
                 calendar: Float
                 dateInstance: (recursive schema, see dateInstance above)
                 dateTimeInstance: (recursive schema, see dateTimeInstance above)
                 instance: (recursive schema, see instance above)
                 lenient: Boolean
                 numberFormat: {
                     availableLocales: [
                         String
                     ]
                     currency: String
                     currencyInstance: (recursive schema, see currencyInstance above)
                     groupingUsed: Boolean
                     instance: (recursive schema, see instance above)
                     integerInstance: (recursive schema, see integerInstance above)
                     maximumFractionDigits: Integer
                     maximumIntegerDigits: Integer
                     minimumFractionDigits: Integer
                     minimumIntegerDigits: Integer
                     numberInstance: (recursive schema, see numberInstance above)
                     parseIntegerOnly: Boolean
                     percentInstance: (recursive schema, see percentInstance above)
                     roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
                 }
                 timeInstance: (recursive schema, see timeInstance above)
                 timeZone: {
                     dstSavings: Integer
                     id: String
                     availableIds: [
                         String
                     ]
                     defaultProperty: (recursive schema, see defaultProperty above)
                     displayName: String
                     rawOffset: Integer
                 }
             }
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         {
                             params: {
                                 String: Object
                             }
                             type: String
                         }
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                 }
             ]
         }
     ]
     classificationDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             entityTypes: [
                 String
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
         }
     ]
     entityDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             subTypes: [
                 String
             ]
             superTypes: [
                 String
             ]
             relationshipAttributeDefs: [
                 {
                     cardinality: String(SINGLE/LIST/SET)
                     constraints: [
                         (recursive schema, see above)
                     ]
                     defaultValue: String
                     description: String
                     includeInNotification: Boolean
                     isIndexable: Boolean
                     isOptional: Boolean
                     isUnique: Boolean
                     name: String
                     options: {
                         String: String
                     }
                     typeName: String
                     valuesMaxCount: Integer
                     valuesMinCount: Integer
                     isLegacyAttribute: Boolean
                     relationshipTypeName: String
                 }
             ]
         }
     ]
     enumDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             defaultValue: String
             elementDefs: [
                 {
                     description: String
                     ordinal: Float
                     value: String
                 }
             ]
         }
     ]
     relationshipDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
             endDef1: {
                 cardinality: String(SINGLE/LIST/SET)
                 description: String
                 isContainer: Boolean
                 isLegacyAttribute: Boolean
                 name: String
                 type: String
             }
             endDef2: (recursive schema, see endDef2 above)
             relationshipCategory: String(ASSOCIATION/AGGREGATION/COMPOSITION)
             relationshipLabel: String
         }
     ]
     structDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
     termTemplateDefs: [
         {
             category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
             createTime: Float
             createdBy: String
             dateFormatter: (recursive schema, see dateFormatter above)
             description: String
             guid: String
             name: String
             options: {
                 String: String
             }
             serviceType: String
             typeVersion: String
             updateTime: Float
             updatedBy: String
             version: Float
             lastModifiedTS: String
             attributeDefs: [
                 (recursive schema, see above)
             ]
         }
     ]
 }
 

Parameters:

typesDef - A composite object that captures all types to be deleted.

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

Returns:

the Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

listTypeDefinitionHeadersWithResponse

public Response<BinaryData> listTypeDefinitionHeadersWithResponse(RequestOptions requestOptions)

List all type definitions returned as a list of minimal information header.

Query Parameters

Query Parameters

Name	Type	Required	Description
includeTermTemplate	Boolean	No	Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template
type	String	No	Typedef name as search filter when get typedefs. Allowed values: enum, entity, classification, relationship, struct, term_template.

Response Body Schema

 [
     {
         category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
         guid: String
         name: String
     }
 ]
 

Parameters:

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

Returns:

an array of AtlasTypeDefHeader matching the search criteria or an empty list if no match along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTermTemplateDefByGuidWithResponse

public Response<BinaryData> getTermTemplateDefByGuidWithResponse(String guid,
 RequestOptions requestOptions)

Get the term template definition for the given GUID.

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

guid - The globally unique identifier of the term template.

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

Returns:

the term template definition for the given GUID along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.

getTermTemplateDefByNameWithResponse

public Response<BinaryData> getTermTemplateDefByNameWithResponse(String name,
 RequestOptions requestOptions)

Get the term template definition by its name (unique).

Response Body Schema

 {
     category: String(PRIMITIVE/OBJECT_ID_TYPE/ENUM/STRUCT/CLASSIFICATION/ENTITY/ARRAY/MAP/RELATIONSHIP/TERM_TEMPLATE)
     createTime: Float
     createdBy: String
     dateFormatter: {
         availableLocales: [
             String
         ]
         calendar: Float
         dateInstance: (recursive schema, see dateInstance above)
         dateTimeInstance: (recursive schema, see dateTimeInstance above)
         instance: (recursive schema, see instance above)
         lenient: Boolean
         numberFormat: {
             availableLocales: [
                 String
             ]
             currency: String
             currencyInstance: (recursive schema, see currencyInstance above)
             groupingUsed: Boolean
             instance: (recursive schema, see instance above)
             integerInstance: (recursive schema, see integerInstance above)
             maximumFractionDigits: Integer
             maximumIntegerDigits: Integer
             minimumFractionDigits: Integer
             minimumIntegerDigits: Integer
             numberInstance: (recursive schema, see numberInstance above)
             parseIntegerOnly: Boolean
             percentInstance: (recursive schema, see percentInstance above)
             roundingMode: String(UP/DOWN/CEILING/FLOOR/HALF_UP/HALF_DOWN/HALF_EVEN/UNNECESSARY)
         }
         timeInstance: (recursive schema, see timeInstance above)
         timeZone: {
             dstSavings: Integer
             id: String
             availableIds: [
                 String
             ]
             defaultProperty: (recursive schema, see defaultProperty above)
             displayName: String
             rawOffset: Integer
         }
     }
     description: String
     guid: String
     name: String
     options: {
         String: String
     }
     serviceType: String
     typeVersion: String
     updateTime: Float
     updatedBy: String
     version: Float
     lastModifiedTS: String
     attributeDefs: [
         {
             cardinality: String(SINGLE/LIST/SET)
             constraints: [
                 {
                     params: {
                         String: Object
                     }
                     type: String
                 }
             ]
             defaultValue: String
             description: String
             includeInNotification: Boolean
             isIndexable: Boolean
             isOptional: Boolean
             isUnique: Boolean
             name: String
             options: {
                 String: String
             }
             typeName: String
             valuesMaxCount: Integer
             valuesMinCount: Integer
         }
     ]
 }
 

Parameters:

name - The name of the term template.

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

Returns:

the term template definition by its name (unique) along with Response.

Throws:

HttpResponseException - thrown if the request is rejected by server.

ClientAuthenticationException - thrown if the request is rejected by server on status code 401.

ResourceNotFoundException - thrown if the request is rejected by server on status code 404.

ResourceModifiedException - thrown if the request is rejected by server on status code 409.