Categorized Web Service Operations
Collapse the table of content
Expand the table of content

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 T:Microsoft.MasterDataServices.IService interface and are implemented as methods in the T: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.

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

M:Microsoft.MasterDataServices.ServiceClient.MetadataClone(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Metadata)
M:Microsoft.MasterDataServices.ServiceClient.MetadataCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Metadata,System.Boolean,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.MetadataDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Metadata)
M:Microsoft.MasterDataServices.ServiceClient.MetadataGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.MetadataResultOptions,Microsoft.MasterDataServices.MetadataSearchCriteria,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.MetadataUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Metadata)

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

M:Microsoft.MasterDataServices.ServiceClient.EntityMemberKeyLookup(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.MemberKeyLookupType,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.MemberKey}@,Microsoft.MasterDataServices.MemberType,Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.Identifier)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersCopy(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembersCopyCriteria)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembers,System.Boolean,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembers)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembersGetCriteria,Microsoft.MasterDataServices.EntityMembersInformation@,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersMerge(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembers,System.Boolean,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.EntityMembersUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembers)

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

M:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkDelete(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.EntityMembers},System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Identifier}@)
M:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkMerge(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.EntityMembers},System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Identifier}@)
M:Microsoft.MasterDataServices.ServiceClient.ModelMembersBulkUpdate(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.EntityMembers},System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Identifier}@)
M:Microsoft.MasterDataServices.ServiceClient.ModelMembersGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.ModelMembersGetCriteria,Microsoft.MasterDataServices.ModelMembersResultCriteria,Microsoft.MasterDataServices.OperationResult@)

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

M:Microsoft.MasterDataServices.ServiceClient.EntityMemberAttributesGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityMembers@)
M:Microsoft.MasterDataServices.ServiceClient.HierarchyMembersGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.HierarchyMembersGetCriteria,Microsoft.MasterDataServices.OperationResult@)

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

M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesClone(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BusinessRules)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BusinessRules@,System.Boolean)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BRDeleteCriteria)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BRGetCriteria,Microsoft.MasterDataServices.BRResultOptions,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesPaletteGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BREntityMemberType,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesPublish(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BRPublishCriteria)
M:Microsoft.MasterDataServices.ServiceClient.BusinessRulesUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.BusinessRules)

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

M:Microsoft.MasterDataServices.ServiceClient.AnnotationsDelete(Microsoft.MasterDataServices.International,System.Int32)
M:Microsoft.MasterDataServices.ServiceClient.AnnotationsUpdate(Microsoft.MasterDataServices.International,System.String,System.Int32)
M:Microsoft.MasterDataServices.ServiceClient.EntityMemberAnnotationsCreate(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Annotation},Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.MemberIdentifier,Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.Identifier)
M:Microsoft.MasterDataServices.ServiceClient.EntityMemberAnnotationsGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Identifier@,Microsoft.MasterDataServices.MemberIdentifier@,Microsoft.MasterDataServices.Identifier@,Microsoft.MasterDataServices.Identifier@,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.TransactionAnnotationsCreate(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Annotation},System.Int32)
M:Microsoft.MasterDataServices.ServiceClient.TransactionAnnotationsGet(Microsoft.MasterDataServices.International,System.Int32@,Microsoft.MasterDataServices.OperationResult@)

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

M:Microsoft.MasterDataServices.ServiceClient.TransactionsGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.TransactionSearchCriteria,System.Int32@,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Transaction}@)
M:Microsoft.MasterDataServices.ServiceClient.TransactionsReverse(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{System.Int32},System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ReplacementId}@)

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

M:Microsoft.MasterDataServices.ServiceClient.VersionCopy(Microsoft.MasterDataServices.International,System.Guid,System.String,System.String)
M:Microsoft.MasterDataServices.ServiceClient.ValidationGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.ValidationSearchCriteria,Microsoft.MasterDataServices.OperationResult@,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ValidationSummaryItem}@,System.Int32@,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ValidationIssue}@)
M:Microsoft.MasterDataServices.ServiceClient.ValidationProcess(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.ValidationProcessCriteria,Microsoft.MasterDataServices.ValidationProcessOptions,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.ValidationIssue}@,Microsoft.MasterDataServices.ValidationProcessResult@)

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

M:Microsoft.MasterDataServices.ServiceClient.DataQualityCleansingOperationCreate(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.DataSourceFieldMapping},System.Int64,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityMatchingOperationCreate(Microsoft.MasterDataServices.International,System.Int64,Microsoft.MasterDataServices.MatchingPolicy,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationStart(Microsoft.MasterDataServices.International,System.Guid,Microsoft.MasterDataServices.OperationResult@,Microsoft.MasterDataServices.OperationStatus@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityInstalledState(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityKnowledgeBasesGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationResultsGet(Microsoft.MasterDataServices.International,System.Int32,System.Guid,System.Int32,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.DataQualityOperationStatus(Microsoft.MasterDataServices.International,System.Guid,Microsoft.MasterDataServices.OperationResult@,Microsoft.MasterDataServices.OperationStatus@)

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

M:Microsoft.MasterDataServices.ServiceClient.EntityStagingClear(Microsoft.MasterDataServices.International,System.Int32,Microsoft.MasterDataServices.Identifier)
M:Microsoft.MasterDataServices.ServiceClient.EntityStagingGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.EntityStagingGetCriteria,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.EntityStagingBatch}@,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.EntityStagingLoad(Microsoft.MasterDataServices.International,System.String,Microsoft.MasterDataServices.EntityStagingImportType,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.EntityMembers},System.Boolean,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Identifier}@)
M:Microsoft.MasterDataServices.ServiceClient.EntityStagingProcess(Microsoft.MasterDataServices.International,System.String,Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.MemberType,Microsoft.MasterDataServices.Identifier,Microsoft.MasterDataServices.OperationResult@)

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.

M:Microsoft.MasterDataServices.ServiceClient.StagingClear(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.Identifier},System.Int32@,System.Int32@,Microsoft.MasterDataServices.OperationResult@,System.Int32@)
M:Microsoft.MasterDataServices.ServiceClient.StagingGet(Microsoft.MasterDataServices.International,System.Boolean,Microsoft.MasterDataServices.StagingResultCriteria,Microsoft.MasterDataServices.StagingSearchCriteria,Microsoft.MasterDataServices.OperationResult@,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.StagingUnbatchedInformation}@)
M:Microsoft.MasterDataServices.ServiceClient.StagingNameCheck(Microsoft.MasterDataServices.International,System.String,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.StagingProcess(Microsoft.MasterDataServices.International,System.Boolean,Microsoft.MasterDataServices.StagingUnbatchedCriteria,Microsoft.MasterDataServices.OperationResult@)

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

M:Microsoft.MasterDataServices.ServiceClient.ExportViewCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.ExportView)
M:Microsoft.MasterDataServices.ServiceClient.ExportViewDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.Identifier)
M:Microsoft.MasterDataServices.ServiceClient.ExportViewListGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.OperationResult@)
M:Microsoft.MasterDataServices.ServiceClient.ExportViewUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.ExportView)

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

M:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsClone(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrincipals)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrincipals,Microsoft.MasterDataServices.SecuritySet@)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrincipalsDeleteCriteria)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrincipalsCriteria,Microsoft.MasterDataServices.SecurityPrincipals@)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrincipalsUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrincipals)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesClone(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrivileges)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesCreate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrivileges,Microsoft.MasterDataServices.SecuritySet@)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesDelete(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrivilegesDeleteCriteria)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrivilegesGetCriteria,Microsoft.MasterDataServices.SecurityPrivileges@)
M:Microsoft.MasterDataServices.ServiceClient.SecurityPrivilegesUpdate(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SecurityPrivileges)

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

M:Microsoft.MasterDataServices.ServiceClient.ServiceCheck(Microsoft.MasterDataServices.International)
M:Microsoft.MasterDataServices.ServiceClient.ServiceVersionGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.OperationResult@,System.Version@)
M:Microsoft.MasterDataServices.ServiceClient.SystemDomainListGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SystemDomainListGetCriteria,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.SystemDomainList}@)
M:Microsoft.MasterDataServices.ServiceClient.SystemPropertiesGet(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.SystemPropertyValue}@)
M:Microsoft.MasterDataServices.ServiceClient.SystemSettingsGet(Microsoft.MasterDataServices.International,Microsoft.MasterDataServices.SystemSettingsGetCriteria,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.SystemSettingGroup}@)
M:Microsoft.MasterDataServices.ServiceClient.SystemSettingsUpdate(Microsoft.MasterDataServices.International,System.Collections.ObjectModel.Collection{Microsoft.MasterDataServices.SystemSettingGroup})
M:Microsoft.MasterDataServices.ServiceClient.UserPreferencesDelete(Microsoft.MasterDataServices.International,System.Boolean,System.Collections.Generic.Dictionary{System.String,System.String})
M:Microsoft.MasterDataServices.ServiceClient.UserPreferencesGet(Microsoft.MasterDataServices.International,System.Collections.Generic.Dictionary{System.String,System.String}@)
M:Microsoft.MasterDataServices.ServiceClient.UserPreferencesUpdate(Microsoft.MasterDataServices.International,System.Collections.Generic.Dictionary{System.String,System.String})
Show:
© 2016 Microsoft