ServiceClient Class

Definition

Contains the various API operations for the service client to interact with Master Data Services.

public ref class ServiceClient : System::ServiceModel::ClientBase<Microsoft::MasterDataServices::IService ^>, Microsoft::MasterDataServices::IService
[System.CodeDom.Compiler.GeneratedCode("System.ServiceModel", "4.0.0.0")]
[System.Diagnostics.DebuggerStepThrough]
public class ServiceClient : System.ServiceModel.ClientBase<Microsoft.MasterDataServices.IService>, Microsoft.MasterDataServices.IService
[<System.CodeDom.Compiler.GeneratedCode("System.ServiceModel", "4.0.0.0")>]
[<System.Diagnostics.DebuggerStepThrough>]
type ServiceClient = class
    inherit ClientBase<IService>
    interface IService
Public Class ServiceClient
Inherits ClientBase(Of IService)
Implements IService
Inheritance
ServiceClient
Attributes
Implements

Constructors

ServiceClient()

Initializes a new instance of the ServiceClient class with default values.

ServiceClient(Binding, EndpointAddress)

Initializes a new instance of the ServiceClient class that has the specified binding and remote address.

ServiceClient(String)

Initializes a new instance of the ServiceClient class with the specified endpoint configuration name.

ServiceClient(String, EndpointAddress)

Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address.

ServiceClient(String, String)

Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address as a string.

Methods

AnnotationsDelete(International, Int32)

Deletes the existing annotation with the specified identifier.

AnnotationsUpdate(International, String, Int32)

Updates the existing annotation with the specified identifier.

AttributeChange(International, MetadataAttribute, Collection<String>, Guid, OperationResult)

Changes an attribute with the specified values.

BusinessRulesClone(International, BusinessRules)

Creates the new business rules using the specified set of business rules, retaining the globally unique identifiers (GUIDs) of the original objects.

BusinessRulesCreate(International, BusinessRules, Boolean)

Creates new business rules instance.

BusinessRulesDelete(International, BRDeleteCriteria)

Deletes the business rule or components of rules with the given criteria.

BusinessRulesGet(International, BRGetCriteria, BRResultOptions, OperationResult)

Retrieves the business rules with the given criteria.

BusinessRulesPaletteGet(International, BREntityMemberType, OperationResult)

Retrieves the available business rule components (the component palette) for the specified member type.

BusinessRulesPublish(International, BRPublishCriteria)

Publishes the business rules with the given criteria.

BusinessRulesUpdate(International, BusinessRules)

Updates the existing business rules.

DataQualityCleansingOperationCreate(International, Collection<DataSourceFieldMapping>, Int64, OperationResult)

Creates an operation for DQS quality cleansing.

DataQualityInstalledState(International, OperationResult)

Determines whether the DQS is properly installed and configured to work with Master Data Services with the specified setting.

DataQualityKnowledgeBasesGet(International, OperationResult)

Gets the collection of knowledgebase configured in DQS.

DataQualityMatchingOperationCreate(International, Int64, MatchingPolicy, OperationResult)

Creates an operation for DQS matching.

DataQualityOperationPurgeOperation(International, Guid)

Returns a purge operation for DQS operation.

DataQualityOperationResultsGet(International, Int32, Guid, Int32, OperationResult)

Retrieves the results of a completed DQS operation.

DataQualityOperationStart(International, Guid, OperationResult, OperationStatus)

Starts a DQS operation.

DataQualityOperationStatus(International, Guid, OperationResult, OperationStatus)

Retrieves the status of a running DQS operation.

DataQualityStoreInputData(International, TabularData, Guid)

Retrieves the data for the data quality store input.

EntityMemberAnnotationsCreate(International, Collection<Annotation>, Identifier, MemberIdentifier, Identifier, Identifier)

Creates new annotations attached to a member.

EntityMemberAnnotationsGet(International, Identifier, MemberIdentifier, Identifier, Identifier, OperationResult)

Retrieves the annotations attached to a member.

EntityMemberAttributesGet(International, EntityMembers)

Retrieves a single attribute value for a member in an entity.

EntityMemberKeyLookup(International, Identifier, MemberKeyLookupType, Collection<MemberKey>, MemberType, Identifier, Identifier)

This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

EntityMembersCopy(International, EntityMembersCopyCriteria)

Copies the selected members to new target members.

EntityMembersCreate(International, EntityMembers, Boolean, OperationResult)

Creates new members.

EntityMembersDelete(International, EntityMembers)

Deletes or deactivates the selected members.

EntityMembersGet(International, EntityMembersGetCriteria, EntityMembersInformation, OperationResult)

Retrieves the filtered set of members and their data from an entity.

EntityMembersMerge(International, EntityMembers, Boolean, OperationResult)

Creates new members and updates existing members.

EntityMembersUpdate(International, EntityMembers)

Updates the existing members.

EntityStagingClear(International, Int32, Identifier)

Clears the entity staging area with the specified batch identifier.

EntityStagingGet(International, EntityStagingGetCriteria, Collection<EntityStagingBatch>, OperationResult)

Retrieves the contents of the entity staging area.

EntityStagingLoad(International, String, EntityStagingImportType, Collection<EntityMembers>, Boolean, Collection<Identifier>)

Loads the members and its relationship into the entity staging area.

EntityStagingProcess(International, String, Identifier, MemberType, Identifier, OperationResult)

Sets the batch, via batch tag, entity identifier, member type, and version identifier, to be queued for processing.

ExportViewCreate(International, ExportView)

Creates a new export (subscription) view.

ExportViewDelete(International, Identifier)

Removes the existing export view with the specified identifier.

ExportViewListGet(International, OperationResult)

Retrieves the list of existing export views.

ExportViewUpdate(International, ExportView)

Updates the existing export view.

HierarchyMembersGet(International, HierarchyMembersGetCriteria, OperationResult)

Retrieves the parent-child members from a hierarchy relative to a parent node.

MetadataClone(International, Metadata)

Creates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.

MetadataCreate(International, Metadata, Boolean, OperationResult)

Creates new metadata components.

MetadataDelete(International, Metadata)

Deletes the specified metadata components.

MetadataGet(International, MetadataResultOptions, MetadataSearchCriteria, OperationResult)

Retrieves the metadata for the given criteria.

MetadataUpdate(International, Metadata)

Updates the specified metadata.

ModelMembersBulkDelete(International, Collection<EntityMembers>, Collection<Identifier>)

Begins the asynchronous bulk deletion of members.

ModelMembersBulkMerge(International, Collection<EntityMembers>, Collection<Identifier>)

Begins the asynchronous bulk creation and/or update of member data across one or more entities.

ModelMembersBulkUpdate(International, Collection<EntityMembers>, Collection<Identifier>)

Begins the asynchronous bulk update of member data across one or more entities.

ModelMembersGet(International, ModelMembersGetCriteria, ModelMembersResultCriteria, OperationResult)

Retrieves the entire selected models, entities and/or hierarchies.

SecurityPrincipalsClone(International, SecurityPrincipals)

Creates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.

SecurityPrincipalsCreate(International, SecurityPrincipals, SecuritySet)

Creates new users, groups and their permissions within the security model.

SecurityPrincipalsDelete(International, SecurityPrincipalsDeleteCriteria)

Deletes users and groups.

SecurityPrincipalsGet(International, SecurityPrincipalsCriteria, SecurityPrincipals)

Retrieves security principals and their permissions.

SecurityPrincipalsUpdate(International, SecurityPrincipals)

Updates security principals.

SecurityPrivilegesClone(International, SecurityPrivileges)

Creates exact copies of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.

SecurityPrivilegesCreate(International, SecurityPrivileges, SecuritySet)

Creates security privileges.

SecurityPrivilegesDelete(International, SecurityPrivilegesDeleteCriteria)

Deletes the permissions for the specified criteria.

SecurityPrivilegesGet(International, SecurityPrivilegesGetCriteria, SecurityPrivileges)

Retrieves the security permissions for selected principals and/or models.

SecurityPrivilegesUpdate(International, SecurityPrivileges)

Updates the specified security privileges.

ServiceCheck(International)

Determines whether the Master Data Services Web service is up and running and is connected to the database.

ServiceVersionGet(International, OperationResult, Version)

Retrieves the version of the service instance.

StagingClear(International, Collection<Identifier>, Int32, Int32, OperationResult, Int32)

Clears the bulk staging area.

StagingGet(International, Boolean, StagingResultCriteria, StagingSearchCriteria, OperationResult, Collection<StagingUnbatchedInformation>)

Retrieves the contents of the bulk staging area.

StagingNameCheck(International, String, OperationResult)

Checks the staging name to see if the name is unique or the name is already used.

StagingProcess(International, Boolean, StagingUnbatchedCriteria, OperationResult)

Sweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.

SystemDomainListGet(International, SystemDomainListGetCriteria, Collection<SystemDomainList>)

Retrieves a localized fixed list of choices based on a list code.

SystemPropertiesGet(International, Collection<SystemPropertyValue>)

Retrieves the immutable properties about the system.

SystemSettingsGet(International, SystemSettingsGetCriteria, Collection<SystemSettingGroup>)

Retrieves the list of system settings.

SystemSettingsUpdate(International, Collection<SystemSettingGroup>)

Updates the system setting values.

TransactionAnnotationsCreate(International, Collection<Annotation>, Int32)

Creates new annotations attached to an existing transaction.

TransactionAnnotationsGet(International, Int32, OperationResult)

Retrieves the filtered list of transaction annotations from a model.

TransactionsGet(International, TransactionSearchCriteria, Int32, Collection<Transaction>)

Retrieves the filtered list of transactions from a model.

TransactionsReverse(International, Collection<Int32>, Collection<ReplacementId>)

Reverses one or more existing transactions.

UserPreferencesDelete(International, Boolean, Dictionary<String,String>)

Deletes the specified user’s preferences.

UserPreferencesGet(International, Dictionary<String,String>)

Retrieves the specified user’s preferences.

UserPreferencesUpdate(International, Dictionary<String,String>)

Updates the specified user’s preferences.

ValidationGet(International, ValidationSearchCriteria, OperationResult, Collection<ValidationSummaryItem>, Int32, Collection<ValidationIssue>)

Gets the validation issues for the given search criteria.

ValidationProcess(International, ValidationProcessCriteria, ValidationProcessOptions, Collection<ValidationIssue>, ValidationProcessResult)

Processes the validations (business rules) for selected members within a model.

VersionCopy(International, Guid, String, String)

Makes a copy of a version, which includes making a copy of all entity member data.

Explicit Interface Implementations

IService.AnnotationsDelete(AnnotationsDeleteRequest)

Deletes an existing annotation.

IService.AnnotationsUpdate(AnnotationsUpdateRequest)

Updates an existing annotation.

IService.AttributeChange(AttributeChangeRequest)

Changes an attribute.

IService.BusinessRulesClone(BusinessRulesCloneRequest)

Creates new business rules which are exact copies of business rules from another source, retaining the globally unique identifiers (GUIDs) of the original objects.

IService.BusinessRulesCreate(BusinessRulesCreateRequest)

Creates new business rules.

IService.BusinessRulesDelete(BusinessRulesDeleteRequest)

Deletes the business rule or components of rules.

IService.BusinessRulesGet(BusinessRulesGetRequest)

Retrieves the business rules.

IService.BusinessRulesPaletteGet(BusinessRulesPaletteGetRequest)

Retrieves the available business rule components (the component palette).

IService.BusinessRulesPublish(BusinessRulesPublishRequest)

Publishes the business rules for a model or entity or member type.

IService.BusinessRulesUpdate(BusinessRulesUpdateRequest)

Updates the existing business rules.

IService.DataQualityCleansingOperationCreate(DataQualityCleansingOperationCreateRequest)

Creates an operation request for DQS quality cleansing.

IService.DataQualityInstalledState(DataQualityInstalledStateRequest)

Retrieves the DQS state – the response is positive if DQS is properly installed and configured to work with Master Data Services.

IService.DataQualityKnowledgeBasesGet(DataQualityKnowledgeBasesGetRequest)

Retrieves the list of knowledgebase configured in DQS.

IService.DataQualityMatchingOperationCreate(DataQualityMatchingOperationCreateRequest)

Creates an operation request for DQS matching.

IService.DataQualityOperationPurgeOperation(DataQualityOperationPurgeOperationRequest)

Returns a purge operation for DQS operation.

IService.DataQualityOperationResultsGet(DataQualityOperationResultsGetRequest)

Retrieves the results of a completed DQS operation.

IService.DataQualityOperationStart(DataQualityOperationStartRequest)

Starts a DQS operation.

IService.DataQualityOperationStatus(DataQualityOperationStatusRequest)

Retrieves the status of a running DQS operation.

IService.DataQualityStoreInputData(DataQualityStoreInputDataRequest)

Retrieves the data for the data quality store input.

IService.EntityMemberAnnotationsCreate(EntityMemberAnnotationsCreateRequest)

Creates new annotations attached to a member.

IService.EntityMemberAnnotationsGet(EntityMemberAnnotationsGetRequest)

Retrieves the annotations attached to a member.

IService.EntityMemberAttributesGet(EntityMemberAttributesGetRequest)

Retrieves the specified set of attribute values from a specified list of members.

IService.EntityMemberKeyLookup(EntityMemberKeyGetRequest)

This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

IService.EntityMembersCopy(EntityMembersCopyRequest)

Copies the selected members to new target members.

IService.EntityMembersCreate(EntityMembersCreateRequest)

Creates new members.

IService.EntityMembersDelete(EntityMembersDeleteRequest)

Deletes or deactivates the selected members.

IService.EntityMembersGet(EntityMembersGetRequest)

Retrieves the filtered set of members and their data from an entity.

IService.EntityMembersMerge(EntityMembersMergeRequest)

Creates new members and updates existing members.

IService.EntityMembersUpdate(EntityMembersUpdateRequest)

Updates the existing members.

IService.EntityStagingClear(EntityStagingClearRequest)

Clears the entity staging area.

IService.EntityStagingGet(EntityStagingGetRequest)

Retrieves the contents of the entity staging area.

IService.EntityStagingLoad(EntityStagingLoadRequest)

Loads the contents of the entity staging area.

IService.EntityStagingProcess(EntityStagingProcessRequest)

Sets the batch to be queued for processing.

IService.ExportViewCreate(ExportViewCreateRequest)

Generates or regenerates the desired subscription views.

IService.ExportViewDelete(ExportViewDeleteRequest)

Removes an existing export view.

IService.ExportViewListGet(ExportViewListGetRequest)

Retrieves the list of existing export views.

IService.ExportViewUpdate(ExportViewUpdateRequest)

Updates an existing export view.

IService.HierarchyMembersGet(HierarchyMembersGetRequest)

Retrieves the parent-child members from a hierarchy relative to a parent node.

IService.MetadataClone(MetadataCloneRequest)

Creates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.

IService.MetadataCreate(MetadataCreateRequest)

Creates new metadata components.

IService.MetadataDelete(MetadataDeleteRequest)

Deletes the metadata components.

IService.MetadataGet(MetadataGetRequest)

Retrieves a metadata.

IService.MetadataUpdate(MetadataUpdateRequest)

Updates a metadata.

IService.ModelMembersBulkDelete(ModelMembersBulkDeleteRequest)

Begins the asynchronous bulk deletion of members.

IService.ModelMembersBulkMerge(ModelMembersBulkMergeRequest)

Begins the asynchronous bulk creation and/or update of member data across one or more entities.

IService.ModelMembersBulkUpdate(ModelMembersBulkUpdateRequest)

Begins the asynchronous bulk update of member data across one or more entities.

IService.ModelMembersGet(ModelMembersGetRequest)

Retrieves the entire selected models, entities and/or hierarchies.

IService.SecurityPrincipalsClone(SecurityPrincipalsRequest)

Creates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.

IService.SecurityPrincipalsCreate(SecurityPrincipalsRequest)

Creates new users, groups and their permissions within the security model.

IService.SecurityPrincipalsDelete(SecurityPrincipalsDeleteRequest)

Deletes user and groups.

IService.SecurityPrincipalsGet(SecurityPrincipalsGetRequest)

Retrieves the security principals and their permissions.

IService.SecurityPrincipalsUpdate(SecurityPrincipalsRequest)

Updates the security principals.

IService.SecurityPrivilegesClone(SecurityPrivilegesRequest)

Creates an exact copy of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.

IService.SecurityPrivilegesCreate(SecurityPrivilegesRequest)

Creates the security privileges.

IService.SecurityPrivilegesDelete(SecurityPrivilegesDeleteRequest)

Deletes the permissions.

IService.SecurityPrivilegesGet(SecurityPrivilegesGetRequest)

Retrieves the security permissions for selected principals and/or models.

IService.SecurityPrivilegesUpdate(SecurityPrivilegesRequest)

Updates the security privileges.

IService.ServiceCheck(ServiceCheckGetRequest)

Determines whether the Master Data Services Web service is up and running and is connected to the database.

IService.ServiceVersionGet(ServiceVersionGetRequest)

Retrieves the service version.

IService.StagingClear(StagingClearRequest)

Clears the bulk staging area.

IService.StagingGet(StagingGetRequest)

Retrieves the contents of the bulk staging area.

IService.StagingNameCheck(StagingNameCheckRequest)

Checks the staging name to see if the name is unique or the name is already used.

IService.StagingProcess(StagingProcessRequest)

Sweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.

IService.SystemDomainListGet(SystemDomainListGetRequest)

Retrieves the localized fixed list of choices based on a list code.

IService.SystemPropertiesGet(SystemPropertiesGetRequest)

Retrieves the immutable properties about the system.

IService.SystemSettingsGet(SystemSettingsGetRequest)

Retrieves the list of system settings.

IService.SystemSettingsUpdate(SystemSettingsUpdateRequest)

Updates the system setting values.

IService.TransactionAnnotationsCreate(TransactionAnnotationsCreateRequest)

Creates new annotations attached to an existing transaction.

IService.TransactionAnnotationsGet(TransactionAnnotationsGetRequest)

Retrieves the filtered list of transaction annotations from a model.

IService.TransactionsGet(TransactionsGetRequest)

Retrieves the filtered list of transactions from a model.

IService.TransactionsReverse(TransactionsReverseRequest)

Reverses one or more existing transactions.

IService.UserPreferencesDelete(UserPreferencesDeleteRequest)

Deletes the current user’s preferences.

IService.UserPreferencesGet(UserPreferencesGetRequest)

Retrieves the current user’s preferences.

IService.UserPreferencesUpdate(UserPreferencesUpdateRequest)

Updates the current user’s preferences.

IService.ValidationGet(ValidationGetRequest)

Gets the validation issues for the given criteria.

IService.ValidationProcess(ValidationProcessRequest)

Processes the validations (business rules) for selected members within a model.

IService.VersionCopy(VersionCopyRequest)

Copies a model version to a new version.

Applies to