Skip to content

Latest commit

 

History

History
146 lines (114 loc) · 10.4 KB

categorized-web-service-operations-master-data-services.md

File metadata and controls

146 lines (114 loc) · 10.4 KB
title description author ms.author ms.date ms.service ms.subservice ms.topic
Categorized Web Service Operations
Categorized Web Service Operations (Master Data Services)
CordeliaGrey
jiwang6
03/15/2017
sql
master-data-services
reference

Categorized Web Service Operations (Master Data Services)

[!INCLUDE SQL Server Windows Only - ASDBMI]

The [!INCLUDEssMDSshort] web service contains a complete set of operations that let you write code to control all of the features that [!INCLUDEssMDSmdm] does through its user interface. The web service operations are defined by the xref:Microsoft.MasterDataServices.IService interface and are implemented as methods in the xref:Microsoft.MasterDataServices.ServiceClient class. This topic groups the web service operations into conceptual categories to help you understand how to use the web service API.

Model Operations

These operations are used to create, update, and delete models, as well as to operate on all the contents of a model, such as entities, hierarchies, and versions. For more information, see Models (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.MetadataClone%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.MetadataCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.MetadataDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.MetadataGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.MetadataUpdate%2A

Entity Operations

These operations are used to create, update, and delete the members of a single entity. For more information, see Entities (Master Data Services) and Members (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMemberKeyLookup%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersCopy%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersMerge%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMembersUpdate%2A

Member Operations

These operations are used to get, update, and delete members. The set of members operated on can contain members from multiple entities. For more information, see Members (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkMerge%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkUpdate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ModelMembersGet%2A

Attribute and Hierarchy Operations

These operations are used to get attribute and hierarchy information. Attributes and hierarchies can also be modified by using the model operations, such as xref:Microsoft.MasterDataServices.ServiceClient.MetadataUpdate%2A. For more information, see Attributes (Master Data Services) and Hierarchies (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMemberAttributesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.HierarchyMembersGet%2A

Business Rule Operations

These operations are used to create, update, delete, and publish business rules. For more information, see Business Rules (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesClone%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesPaletteGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesPublish%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.BusinessRulesUpdate%2A

Annotation Operations

These operations are used to create, update, and delete annotations. For more information, see Annotations (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.AnnotationsDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.AnnotationsUpdate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMemberAnnotationsCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityMemberAnnotationsGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.TransactionAnnotationsCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.TransactionAnnotationsGet%2A

Transaction Operations

These operations are used to get and reverse transactions. For more information, see Transactions (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.TransactionsGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.TransactionsReverse%2A

Version and Validation Operations

These operations are used to copy and validate versions. For more information, see Versions (Master Data Services) and Validation (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.VersionCopy%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ValidationGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ValidationProcess%2A

Data Quality Operations

These operations are used to perform data quality tasks and to examine their results.

  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityCleansingOperationCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityMatchingOperationCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityInstalledState%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityKnowledgeBasesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationStart%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationResultsGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationStatus%2A

Data Import Operations

These operations are used to import data into a [!INCLUDEssMDSshort] database. For more information, see Overview: Importing Data from Tables (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.EntityStagingClear%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityStagingGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityStagingLoad%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.EntityStagingProcess%2A

The following operations are used to import data by using the staging process included in [!INCLUDEsql2008r2]. These operations should be used only to support existing databases. For new development, use the previously listed operations.

  • xref:Microsoft.MasterDataServices.ServiceClient.StagingClear%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.StagingGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.StagingNameCheck%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.StagingProcess%2A

Data Export Operations

These operations are used to export data through the use of subscription views. For more information, see Overview: Exporting Data (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.ExportViewCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ExportViewDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ExportViewListGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ExportViewUpdate%2A

Security Operations

These operations are used to modify the security settings that control access to the [!INCLUDEssMDSshort] database. For more information, see Security (Master Data Services).

  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsClone%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsUpdate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesClone%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesCreate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesUpdate%2A

System Operations

These operations are used to get and update system settings and user preferences.

  • xref:Microsoft.MasterDataServices.ServiceClient.ServiceCheck%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.ServiceVersionGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SystemDomainListGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SystemPropertiesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SystemSettingsGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.SystemSettingsUpdate%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.UserPreferencesDelete%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.UserPreferencesGet%2A
  • xref:Microsoft.MasterDataServices.ServiceClient.UserPreferencesUpdate%2A