Skip to content

11-1-0 (GA scheduled 01/31/2024)

New Or Improved API Methods

The following API methods were added or improved with MM 11.1.0.

New or improved API methods Group Summary
POST /dataModel/entityRelationship Data Model A new API function to allow the user to create an Entity Relationship between two classifiers.
DELETE /dataModel/entityRelationship Data Model A new API function to allow the user to delete an Entity Relationship between two classifiers.
POST /repository/dashboard/import Repository A new API function to allow the user to import the dashboard JSON definition from a file.
POST /repository/dashboard/export Repository A new API function to allow the user to export the JSON definition of a dashboard to a file.
POST /semanticMapping/semanticLink Semantic Mapping A new API function to allow the user to create a new semantic link between two objects.
DELETE /semanticMapping/semanticLink Semantic Mapping A new API function to allow the user to delete a semantic link between two objects.
POST /entities/getAttributeValueCounts Browse New parameter "dateRangeGap": Allow the user to specify a range gap (YEAR, MONTH, DAY or HOUR) for faceting if the attribute is of the date or datetime data type.
GET /entities/{objectId}GET /entities/validateMQLQueryGET /entities/countMQLQueryGET /relationships/{objectId}GET /relationships/count/{objectId} Browse New parameter "mqlVersion": The MQL version. The current MQL version is 3. Specify a number less than 3 if you want to use deprecated syntax and/or MQL system attributes.
POST /entities/executeMQLQueryPOST /entities/getAttributeValueCounts Browse New property "mqlVersion" of Request body: The MQL version. The current MQL version is 3. Specify a number less than 3 if you want to use deprecated syntax and/or MQL system attributes.
POST /entities/executeMQLQuery Browse New property "namingStandard" of Request body: The name of a naming standard to provide synonyms used in search.
POST /entities/upgradeMQLQuery Browse Upgrade the Request body to the latest MQL syntax
POST /License/updateLicense License Update license
POST /repository/model/export Repository New parameter "exportDataProfilingAndSampling"
DELETE /admin/users Users New parameter "newOwner" to allow the ownership of customizations to be transferred when a user is being deleted.

For more information about the MQL version, please refer to Metadata Query Language (MQL).

Deprecated API Methods, Parameters or Schemas

Deprecated API methods, parameters or schemas do not require any action before upgrading to MM 11.1.0. They will continue to work as normal in MM 11.1.0. We plan to remove them in the next major release.

Deprecation of API methods, parameters, or schemas Replacements More information
The header parameter "api_key" "api-key" Support AWS
POST /repository/semanticMapping/exportCSV POST /repository/model/export Consolidate the import/export APIs
POST /repository/semanticMapping/importCSV POST /repository/model/import Consolidate the import/export APIs
POST /operations/glossary/exportAndDownloadCSV POST /repository/model/export Consolidate the import/export APIs
PUT /entities/glossary/classify POST /semanticMapping/semanticLink Improve mapped data documentation
PUT /entities/glossary/unclassify DELETE /semanticMapping/semanticLink Improve mapped data documentation
POST /repository/createRelationship POST /dataModel/entityRelationship New relationships as object types
The scope parameter or field of the request body of:GET /entities/validateMQLQueryPOST /entities/executeMQLQueryGET /entities/countMQLQueryPOST /entities/getAttributeValueCounts Model =WHERE (…) filter in the WHERE clause MQL normalization
POST /repository/databaseDocumentation/importCSV parameter separator Removed the CSV separator parameter. MM automatically detects the separator by reading the first line of the CSV file.
POST /repository/model/import parameter separator Removed the CSV separator parameter. MM automatically detects the separator by reading the first line of the CSV file.
POST /repository/semanticMapping/importCSV parameter separator Removed the CSV separator parameter. MM automatically detects the separator by reading the first line of the CSV file.

Removed API Methods, Parameters or Schemas

The following table lists API methods, parameters and schemas removed with MM 11.1.0 and the recommended methods, parameters and schemas to replace them. Please ensure your applications do not use any of these methods before upgrading to MM 11.1.0.

Removal of API methods, parameters, or schemas Replacements More information
POST /repository/databaseDocumentation/exportCSV POST /repository/model/export Deprecated with MM 11.0.0 to consolidate the import/export APIs
GET /repository/semanticTypes GET /repository/dataClasses Deprecated with MM 11.0.0 to rebrand "Semantic Type" as "Data Class"
GET /repository/semanticTypes/{objectId} GET /repository/dataClasses/{objectId} Deprecated with MM 11.0.0 to rebrand "Semantic Type" as "Data Class"
PUT /repository/semanticTypes/{objectId} PUT /repository/dataClasses/{objectId} Deprecated with MM 11.0.0 to rebrand "Semantic Type" as "Data Class"
POST /entities/executeMQLQuery parameter legacyEntityFormat Deprecated with MM 11.0.0. This function will always return results in the MQL Entity Format
POST /entities/getAttributeDistinctValueCounts POST /entities/getAttributeValueCounts Deprecated with MM 11.0.0 as the new function is more efficient
POST /entities/getInferredSemanticObjects POST /entities/executeMQLQuery Deprecated with MM 11.0.0. Use the system attribute "Inferred Documentation" to get inferred documentation of the object
POST /dataMapping/exportExcel POST /dataMapping/exportScript Deprecated with MM 11.0.0. The output of the new function can be edited by the user and imported back via POST /dataMapping/importScript
POST /entities/DataProfiling/{objectId} parameter hideData new parameter sensitivityLabel Deprecated with MM 11.0.0. Use sensitivity label to hide data
GET /types/listEntityTypes GET /types/listObjectTypes Deprecated with MM 11.0.0 to rebrand entity type as object type
GET /repository/customAttributes/{nameOrId} POST /repository/metaModel/exportXML Deprecated with MM 11.0.0 to rebrand custom attributes as Meta model attribute types. Export the Meta model to view the definition of any attribute type.
POST /operations/glossary/exportAndDownloadCSV POST /repository/model/export Deprecated with MM 11.0.0. Specify the objectIds parameter to export a term or a list of terms.
PUT /repository/setCustomAttributes PUT /repository/setAttributes Deprecated with MM 11.0.0 to rebrand custom attributes as Meta model attribute types.
GET /entities/DataProfiling/{objectId} Removed the following fields in the result: totalSemanticTypeRows, invalidSemanticTypeValues and inferredSemanticTypes. Deprecated with MM 11.0.0. Removed data classes from data profiling.
PUT /entities/DataProfiling/{objectId} Removed the following fields in the Request body: totalSemanticTypeRows, invalidSemanticTypeValues and inferredSemanticTypes. Deprecated with MM 11.0.0. Removed data classes from data profiling.
POST /entities/glossary parameter categoryPath new parameter termPath Deprecated with MM 11.0.0. Removed category from glossary.
GET /types/listAttributeTypes parameter entityType new parameter objectType Deprecated with MM 11.0.0 to rebrand entity type as object type.
GET /types/listGroupTypes parameter entityType new parameter objectType Deprecated with MM 11.0.0 to rebrand entity type as object type.
Schema Entity's field entityType new field objectType Deprecated with MM 11.0.0 to rebrand entity type as object type.
Schema Entity's field term new field terms Deprecated with MM 11.0.0 as an object can be defined by multiple terms.
Schema Entity's field semanticTypes new field dataClassifications Deprecated with MM 11.0.0 to rebrand semantic type as data classification.
Enumeration type ReferenceType used by Schema GlossaryTermReference's type field Replaced "More General" with "Specializes", "More Specific" with "Generalizes". Added "Possible Value" and "Possible Value Of". New meta model relationships for Term
Schema ModelSettings_Create's field "Send email notification when an import" Deprecated with MM 11.0.0. Notifications are sent to model watchers for model changes and metadata managers for import failures. There are no more notification options in the content.
Schema ModelSettings_Create_Data's field "Data hiding" new field "Hide data using Sensitivity Label" Deprecated with MM 11.0.0 as Data hiding is controlled by the sensitivity label defined on the field
Schema ModelSettings_Set's field "Send email notification when an import" Deprecated with MM 11.0.0. Notifications are sent to model watchers for model changes and metadata managers for import failures. There are no more notification options in the content.
Schema LIneageLink’s field lineageType new field lineageTypeText Deprecated with MM 11.0.0. Switched from the integer field lineageType to the string field lineageTypeText to be more descriptive.
Schema LineageNode’s field modifiers Deprecated with MM 11.0.0 as it is not useful for the users
Schema LineageTree’s field text Deprecated with MM 11.0.0 it is not useful for the users
The field of hideData in the schemas: DataClass and DataClassWithStatus new field sensitivityLabel Deprecated with MM 11.0.0 to use sensitivity label to hide data
GET /repository/dataClasses parameter hideDataOption new parameter sensitivityLabelOption Deprecated with MM 11.0.0 to use sensitivity label to hide data

11-0-0 (GA 01/31/2022 - Deprecated 12/31/2024 - EOL 12/31/2025)

New Or Improved API Methods

The following API methods were added or improved with MM 11.0.0.

New or improved API methods Group Summary
GET /entities/validateMQLQuery Browse New parameter "scope": Scope conditions in MQL syntax to further restrict the models or objects in the FROM
POST /entities/executeMQLQuery Browse New field "scope" in the request body: Scope conditions in MQL syntax to further restrict the models or objects in the FROM
GET /entities/countMQLQuery Browse New parameter "scope": Scope conditions in MQL syntax to further restrict the models or objects in the FROM
POST /entities/executeWorksheet Browse Get the objects of a worksheet
GET /entities/countWorksheet Browse Get the total number of objects of a worksheet
POST /entities/getAttributeValueCounts Browse New field "scope" in the request body: Scope conditions in MQL syntax to further restrict the models or objects in the FROM
POST /entities/Dataprofiling/{objectId} Browse New parameter "sensitivityLabel": allow the user to propose a sensitivity label
GET /repository/dataClasses/ Data Classes Rebrand "Semantic Type" as "Data Class"
GET /repository/dataClasses/{objectId} Data Classes Rebrand "Semantic Type" as "Data Class"
PUT /repository/dataClasses/{objectId} Data Classes Rebrand "Semantic Type" as "Data Class"
POST /dataMapping/exportScript Data Mapping Export a Data Mapping to data mapping script format files using the Default Server
POST /dataMapping/importScript Data Mapping Import the data mapping from data mapping format script files
PUT /entities/glossary/classify/{objectId} Glossary Classify an object with an existing term or using a new term
PUT /entities/glossary/unclassify/{objectId} Glossary Unclassify an object
POST /operations/glossary/exportAndDownloadCSV Glossary Download glossary terms that belong to a term or a list of terms recursively
GET /lineage/getOperations/{startingId} Lineage Get operations/transformation logic
GET /operations/listOperations Operation Get operations
POST /operations/downloadOperationLog/{operationId} Operation Download the log of an operation
POST /repository/metaModel/importXML Repository Import the meta model from an XML file
POST /repository/metaModel/exportXML Repository Export a meta model package as an XML file
POST /repository/model/import Repository Import the custom model or imported model from a zip file which contains the CSV files
POST /repository/model/export Repository Export the custom model or imported model as a zip file which contains the CSV files
POST /repository/backup Repository This function now backs up to a zip file
POST /repository/restore Repository This function now restores from a zip file
GET /admin/grants/getGlobalRoles Roles Get the global role(s) of a user or user group
GET /admin/grants/getGlobalGrantees Roles Get the users or user groups who have a particular global role
PUT /admin/grants/grantGlobalRoles Roles Grant a global role to a user or user group
PUT /admin/grants/revokeGlobalRole Roles Revoke a global role from a user or user group
GET /admin/grants/getObjectRoles/{objectId} Roles Get the role(s) of a user or user group on an object
GET /admin/grants/getObjectGrantees/{objectId} Roles Get the users or user groups who have a particular role on an object
PUT /admin/grants/grantObjectRole/{objectId} Roles Grant a role on an object to a user or user group
PUT /admin/grants/revokeObjectRole/{objectId} Roles Revoke a role on an object from a user or user group
POST /admin/grants/importGlobalRolesCSV Roles Import the global roles from a CSV file
POST /admin/grants/exportGlobalRolesCSV Roles Export the global roles as a CSV file
POST /admin/grants/importObjectRolesCSV Roles Import the object roles from a CSV file
POST /admin/grants/exportObjectRolesCSV Roles Export the object roles as a CSV file
GET /repository/sensitivityLabels/ Sensitivity Labels Get sensitivity labels
GET /repository/sensitivityLabels/{objectId} Sensitivity Labels Get the sensitivity label associated with an object
PUT /repository/sensitivityLabels/{objectId} Sensitivity Labels Maintain the sensitivity label associated with an object
PUT /admin/users Users In order to update a user's password an old password is required now

Deprecated API Methods, Parameters or Schemas

Deprecated API methods, parameters or schemas do not require any action before upgrading to MM 11.0.0. They will continue to work as normal in MM 11.0.0. We plan to remove them in the next major release.

Deprecation of API methods, parameters, or schemas Replacements More information
POST /repository/databaseDocumentation/exportCSV POST /repository/model/export Consolidate the import/export APIs
GET /repository/semanticTypes GET /repository/dataClasses Rebrand "Semantic Type" as "Data Class"
GET /repository/semanticTypes/{objectId} GET /repository/dataClasses/{objectId} Rebrand "Semantic Type" as "Data Class"
PUT /repository/semanticTypes/{objectId} PUT /repository/dataClasses/{objectId} Rebrand "Semantic Type" as "Data Class"
POST /entities/executeMQLQuery parameter legacyEntityFormat This function will always return results in the MQL Entity Format
POST /entities/getAttributeDistinctValueCounts POST /entities/getAttributeValueCounts The new function is more efficient
POST /entities/getInferredSemanticObjects POST /entities/executeMQLQuery Use the system attribute "Inferred Documentation" to get inferred documentation of the object
POST /dataMapping/exportExcel POST /dataMapping/exportScript The output of the new function can be edited by the user and imported back via POST /dataMapping/importScript
POST /entities/DataProfiling/{objectId} parameter hideData new parameter sensitivityLabel Use sensitivity label to hide data
GET /types/listEntityTypes GET /types/listObjectTypes Rebrand entity type as object type
GET /repository/customAttributes/{nameOrId} POST /repository/metaModel/exportXML Rebrand custom attributes as Meta model attribute types. Export the Meta model to view the definition of any attribute type.
POST /operations/glossary/exportAndDownloadCSV POST /repository/model/export Specify the objectIds parameter to export a term or a list of terms.
PUT /repository/setCustomAttributes PUT /repository/setAttributes Rebrand custom attributes as Meta model attribute types
GET /entities/DataProfiling/{objectId} Deprecated the following fields in the result: totalSemanticTypeRows, invalidSemanticTypeValues and inferredSemanticTypes. Removed data classes from data profiling. Note that these fields are not set in the output.
PUT /entities/DataProfiling/{objectId} Deprecated the following fields in the Request body: totalSemanticTypeRows, invalidSemanticTypeValues and inferredSemanticTypes. Removed data classes from data profiling. Note that these fields in the input will be ignored.
POST /entities/glossary parameter categoryPath new parameter termPath Removed category from glossary
GET /types/listAttributeTypes parameter entityType new parameter objectType Rebrand entity type as object type
GET /types/listGroupTypes parameter entityType new parameter objectType Rebrand entity type as object type
Schema Entity's field entityType new field objectType Rebrand entity type as object type. Note that entityType and objectType are set to the same value for MM 11.0.
Schema Entity's field term new field terms Object can be defined by multiple terms. The field term will store the first term if the object has multiple terms.
Schema Entity's field semanticTypes new field dataClassifications Rebrand semantic type as data classification. Note that semanticTypes and dataClassifications are set to the same value for MM 11.0.
Enumeration type ReferenceType used by Schema GlossaryTermReference's type field Replaced "More General" with "Specializes", "More Specific" with "Generalizes". Added "Possible Value" and "Possible Value Of". New meta model relationships for Term
Schema ModelSettings_Create's field "Send email notification when an import" Notifications are sent to model watchers for model changes and metadata managers for import failures. There are no more notification options in the content.
Schema ModelSettings_Create_Data's field "Data hiding" new field "Hide data using Sensitivity Label" Data hiding is controlled by the sensitivity label defined on the field
Schema ModelSettings_Set's field "Send email notification when an import" Notifications are sent to model watchers for model changes and metadata managers for import failures. There are no more notification options in the content.
Schema LIneageLink’s field lineageType new field lineageTypeText Switched from the integer field lineageType to the string field lineageTypeText to be more descriptive.
Schema LineageNode’s field modifiers It is not useful for the users
Schema LineageTree’s field text It is not useful for the users
The field of hideData in the schemas: DataClass and DataClassWithStatus new field sensitivityLabel Use sensitivity label to hide data
GET /repository/dataClasses parameter hideDataOption new parameter sensitivityLabelOption Use sensitivity label to hide data

Removed API Methods, Parameters or Schemas

The following table lists API methods removed with MM 11.0.0 and the recommended methods to replace them. Please ensure your applications do not use any of these methods before upgrading to MM 11.0.0.

Removal of API methods, parameters, or schemas Replacements More information
GET /auth/login POST /auth/login Deprecated with MM 10.1.0 as the POST method is more secure
GET /auth/loginPlainText POST /auth/loginPlainText Deprecated with MM 10.1.0 as the POST method is more secure
GET /auth/loginOAuth2 POST /auth/loginOAuth2 Deprecated with MM 10.1.0 as the POST method is more secure
POST /entities POST /entities/executeMQLQuery Deprecated with MM 10.1.0 as the new function provides better functionality
POST /entities/countEntities GET /entities/countMQLQuery Deprecated with MM 10.1.0 as the new function provides better functionality
GET /repository/getModelImportParameters GET /repository/importModel Deprecated with MM 10.1.0 as the new function provides better functionality
PUT /repository/setModelImportParameters PUT /repository/importModel Deprecated with MM 10.1.0 as the new function provides better functionality
GET /repository/getDataParameters GET /repository/importModel Deprecated with MM 10.1.0 as the new function provides better functionality
PUT /repository/setDataParameters PUT /repository/importModel Deprecated with MM 10.1.0 as the new function provides better functionality
POST /operations/repositoryExport/attachFile POST /repository/attachments/{objectId} Deprecated with MM 10.1.0 as the new function provides better functionality
POST /search/entity POST /entities/executeMQLQuery Deprecated with MM 10.1.0 as the new function provides better functionality
POST /entities/getAttributeStatistics Deprecated with MM 10.1.0 as this function was rarely used by users
POST /entities/getAttributeStatisticsCount Deprecated with MM 10.1.0 as this function was rarely used by users
GET /admin/grants/{objectId} GET /admin/grants/getObjectRoles/{objectId} This function no longer complies with the MM 11.0 object role framework
PUT /admin/grants/{objectId}/{userGroupId} PUT /admin/grants/grantObjectRole/{objectId} and PUT /admin/grants/revokeObjectRole/{objectId} This function no longer complies with the MM 11.0 object role framework
GET /admin/stewards/{objectId} GET /admin/grants/getObjectGrantees/{objectId} This function no longer complies with the MM 11.0 object role framework
PUT /admin/stewards/{objectId} PUT /admin/grants/grantObjectRole/{objectId} and PUT /admin/grants/revokeObjectRole/{objectId} This function no longer complies with the MM 11.0 object role framework
POST /repository/backup parameter backupAllVersions backupCachedModels This parameter is deprecated with MM 10.1.0.

All steward related fields have been removed from the schemas. For example, the CreateUser and CreateUserGroup no longer have the steward field.