Share via


Categorized Web Service Operations (Master Data Services)

The Master Data Services web service contains a complete set of operations that let you write code to control all of the features that Master Data Manager does through its user interface. The web service operations are defined by the Microsoft.MasterDataServices.IService interface and are implemented as methods in the 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).

MetadataClone

MetadataCreate

MetadataDelete

MetadataGet

MetadataUpdate

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

EntityMemberKeyLookup

EntityMembersCopy

EntityMembersCreate

EntityMembersDelete

EntityMembersGet

EntityMembersMerge

EntityMembersUpdate

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

ModelMembersBulkDelete

ModelMembersBulkMerge

ModelMembersBulkUpdate

ModelMembersGet

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 MetadataUpdate. For more information, see Attributes (Master Data Services) and Hierarchies (Master Data Services).

EntityMemberAttributesGet

HierarchyMembersGet

Business Rule Operations

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

BusinessRulesClone

BusinessRulesCreate

BusinessRulesDelete

BusinessRulesGet

BusinessRulesPaletteGet

BusinessRulesPublish

BusinessRulesUpdate

Annotation Operations

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

AnnotationsDelete

AnnotationsUpdate

EntityMemberAnnotationsCreate

EntityMemberAnnotationsGet

TransactionAnnotationsCreate

TransactionAnnotationsGet

Transaction Operations

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

TransactionsGet

TransactionsReverse

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

VersionCopy

ValidationGet

ValidationProcess

Data Quality Operations

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

Microsoft.MasterDataServices.ServiceClient.DataQualityCleansingOperationStart(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ColumnMapping},Microsoft.MasterDataServices.TabularData,System.Int64,Microsoft.MasterDataServices.OperationResult@,Microsoft.MasterDataServices.OperationStatus@)

DataQualityInstalledState

DataQualityKnowledgeBasesGet

Microsoft.MasterDataServices.ServiceClient.DataQualityMatchingOperationStart(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ColumnMapping},Microsoft.MasterDataServices.TabularData,System.Int64,Microsoft.MasterDataServices.MatchingPolicy,Microsoft.MasterDataServices.OperationResult@,Microsoft.MasterDataServices.OperationStatus@)

Microsoft.MasterDataServices.ServiceClient.DataQualityOperationResultsGet(Microsoft.MasterDataServices.International,System.Guid,Microsoft.MasterDataServices.OperationResult@)

Microsoft.MasterDataServices.ServiceClient.DataQualityOperationStatus(Microsoft.MasterDataServices.International,System.Guid,Microsoft.MasterDataServices.OperationStatus@)

Data Import Operations

These operations are used to import data into a Master Data Services database. For more information, see Importing Data (Master Data Services).

EntityStagingClear

EntityStagingGet

EntityStagingLoad

EntityStagingProcess

The following operations are used to import data by using the staging process included in SQL Server 2008 R2. These operations should be used only to support existing databases. For new development, use the previously listed operations.

StagingClear

StagingGet

StagingNameCheck

StagingProcess

Data Export Operations

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

ExportViewCreate

ExportViewDelete

ExportViewListGet

ExportViewUpdate

Security Operations

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

SecurityPrincipalsClone

SecurityPrincipalsCreate

SecurityPrincipalsDelete

SecurityPrincipalsGet

SecurityPrincipalsUpdate

SecurityPrivilegesClone

SecurityPrivilegesCreate

SecurityPrivilegesDelete

SecurityPrivilegesGet

SecurityPrivilegesUpdate

System Operations

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

ServiceCheck

Microsoft.MasterDataServices.ServiceClient.ServiceVersionGet(Microsoft.MasterDataServices.OperationResult@,System.Version@)

SystemDomainListGet

SystemPropertiesGet

SystemSettingsGet

SystemSettingsUpdate

UserPreferencesDelete

UserPreferencesGet

UserPreferencesUpdate