Export (0) Print
Expand All

ServiceClient Class

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

Object
  ClientBase<IService>
    Microsoft.MasterDataServices::ServiceClient

Namespace:  Microsoft.MasterDataServices
Assembly:  Microsoft.MasterDataServices (in Microsoft.MasterDataServices.dll)

public ref class ServiceClient : public ClientBase<IService^>, 
	IService

The ServiceClient type exposes the following members.

  NameDescription
Public methodServiceClient()Initializes a new instance of the ServiceClient class with default values.
Public methodServiceClient(String)Initializes a new instance of the ServiceClient class with the specified endpoint configuration name.
Public methodServiceClient(Binding, EndpointAddress)Initializes a new instance of the ServiceClient class that has the specified binding and remote address.
Public methodServiceClient(String, EndpointAddress)Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address.
Public methodServiceClient(String, String)Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address as a string.
Top

  NameDescription
Protected propertyChannel (Inherited from ClientBase<IService>.)
Public propertyChannelFactory (Inherited from ClientBase<IService>.)
Public propertyClientCredentials (Inherited from ClientBase<IService>.)
Public propertyEndpoint (Inherited from ClientBase<IService>.)
Public propertyInnerChannel (Inherited from ClientBase<IService>.)
Public propertyState (Inherited from ClientBase<IService>.)
Top

  NameDescription
Public methodAbort (Inherited from ClientBase<IService>.)
Public methodAnnotationsDeleteDeletes the existing annotation with the specified identifier.
Public methodAnnotationsUpdateUpdates the existing annotation with the specified identifier.
Public methodAttributeChangeChanges an attribute with the specified values.
Public methodBusinessRulesCloneCreates the new business rules using the specified set of business rules, retaining the globally unique identifiers (GUIDs) of the original objects.
Public methodBusinessRulesCreateCreates new business rules instance.
Public methodBusinessRulesDeleteDeletes the business rule or components of rules with the given criteria.
Public methodBusinessRulesGetRetrieves the business rules with the given criteria.
Public methodBusinessRulesPaletteGetRetrieves the available business rule components (the component palette) for the specified member type.
Public methodBusinessRulesPublishPublishes the business rules with the given criteria.
Public methodBusinessRulesUpdateUpdates the existing business rules.
Public methodClose (Inherited from ClientBase<IService>.)
Protected methodCreateChannel (Inherited from ClientBase<IService>.)
Public methodDataQualityCleansingOperationCreateInfrastructure. Creates an operation for DQS quality cleansing.
Public methodDataQualityInstalledStateInfrastructure. Determines whether the DQS is properly installed and configured to work with Master Data Services with the specified setting.
Public methodDataQualityKnowledgeBasesGetInfrastructure. Gets the collection of knowledgebase configured in DQS.
Public methodDataQualityMatchingOperationCreateInfrastructure. Creates an operation for DQS matching.
Public methodDataQualityOperationPurgeOperationInfrastructure. Returns a purge operation for DQS operation.
Public methodDataQualityOperationResultsGetInfrastructure. Retrieves the results of a completed DQS operation.
Public methodDataQualityOperationStartInfrastructure. Starts a DQS operation.
Public methodDataQualityOperationStatusInfrastructure. Retrieves the status of a running DQS operation.
Public methodDataQualityStoreInputDataInfrastructure. Retrieves the data for the data quality store input.
Public methodDisplayInitializationUI (Inherited from ClientBase<IService>.)
Public methodEntityMemberAnnotationsCreateCreates new annotations attached to a member.
Public methodEntityMemberAnnotationsGetRetrieves the annotations attached to a member.
Public methodEntityMemberAttributesGetRetrieves a single attribute value for a member in an entity.
Public methodEntityMemberKeyLookupThis 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.
Public methodEntityMembersCopyCopies the selected members to new target members.
Public methodEntityMembersCreateCreates new members.
Public methodEntityMembersDeleteDeletes or deactivates the selected members.
Public methodEntityMembersGetRetrieves the filtered set of members and their data from an entity.
Public methodEntityMembersMergeCreates new members and updates existing members.
Public methodEntityMembersUpdateUpdates the existing members.
Public methodEntityStagingClearInfrastructure. Clears the entity staging area with the specified batch identifier.
Public methodEntityStagingGetInfrastructure. Retrieves the contents of the entity staging area.
Public methodEntityStagingLoadInfrastructure. Loads the members and its relationship into the entity staging area.
Public methodEntityStagingProcessInfrastructure. Sets the batch, via batch tag, entity identifier, member type, and version identifier, to be queued for processing.
Public methodEquals (Inherited from Object.)
Public methodExportViewCreateCreates a new export (subscription) view.
Public methodExportViewDeleteRemoves the existing export view with the specified identifier.
Public methodExportViewListGetRetrieves the list of existing export views.
Public methodExportViewUpdateUpdates the existing export view.
Protected methodFinalize (Inherited from Object.)
Protected methodGetDefaultValueForInitialization``1 (Inherited from ClientBase<IService>.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodHierarchyMembersGetRetrieves the parent-child members from a hierarchy relative to a parent node.
Protected methodInvokeAsync (Inherited from ClientBase<IService>.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMetadataCloneCreates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Public methodMetadataCreateCreates new metadata components.
Public methodMetadataDeleteDeletes the specified metadata components.
Public methodMetadataGetRetrieves the metadata for the given criteria.
Public methodMetadataUpdateUpdates the specified metadata.
Public methodModelMembersBulkDeleteBegins the asynchronous bulk deletion of members.
Public methodModelMembersBulkMergeBegins the asynchronous bulk creation and/or update of member data across one or more entities.
Public methodModelMembersBulkUpdateBegins the asynchronous bulk update of member data across one or more entities.
Public methodModelMembersGetRetrieves the entire selected models, entities and/or hierarchies.
Public methodOpen (Inherited from ClientBase<IService>.)
Public methodSecurityPrincipalsCloneCreates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.
Public methodSecurityPrincipalsCreateCreates new users, groups and their permissions within the security model.
Public methodSecurityPrincipalsDeleteDeletes users and groups.
Public methodSecurityPrincipalsGetRetrieves security principals and their permissions.
Public methodSecurityPrincipalsUpdateUpdates security principals.
Public methodSecurityPrivilegesCloneCreates exact copies of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Public methodSecurityPrivilegesCreateCreates security privileges.
Public methodSecurityPrivilegesDeleteDeletes the permissions for the specified criteria.
Public methodSecurityPrivilegesGetRetrieves the security permissions for selected principals and/or models.
Public methodSecurityPrivilegesUpdateUpdates the specified security privileges.
Public methodServiceCheckDetermines whether the Master Data Services Web service is up and running and is connected to the database.
Public methodServiceVersionGetRetrieves the version of the service instance.
Public methodStagingClearClears the bulk staging area.
Public methodStagingGetRetrieves the contents of the bulk staging area.
Public methodStagingNameCheckChecks the staging name to see if the name is unique or the name is already used.
Public methodStagingProcessSweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.
Public methodSystemDomainListGetRetrieves a localized fixed list of choices based on a list code.
Public methodSystemPropertiesGetRetrieves the immutable properties about the system.
Public methodSystemSettingsGetRetrieves the list of system settings.
Public methodSystemSettingsUpdateUpdates the system setting values.
Public methodToString (Inherited from Object.)
Public methodTransactionAnnotationsCreateCreates new annotations attached to an existing transaction.
Public methodTransactionAnnotationsGetRetrieves the filtered list of transaction annotations from a model.
Public methodTransactionsGetRetrieves the filtered list of transactions from a model.
Public methodTransactionsReverseReverses one or more existing transactions.
Public methodUserPreferencesDeleteDeletes the specified user’s preferences.
Public methodUserPreferencesGetRetrieves the specified user’s preferences.
Public methodUserPreferencesUpdateUpdates the specified user’s preferences.
Public methodValidationGetGets the validation issues for the given search criteria.
Public methodValidationProcessProcesses the validations (business rules) for selected members within a model.
Public methodVersionCopyMakes a copy of a version, which includes making a copy of all entity member data.
Top

  NameDescription
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#BeginClose(AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#BeginClose(TimeSpan, AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#BeginOpen(AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#BeginOpen(TimeSpan, AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#Close (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate eventSystem#ServiceModel#ICommunicationObject#Closed (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate eventSystem#ServiceModel#ICommunicationObject#Closing (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#IDisposable#Dispose (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#EndClose (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#EndOpen (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate eventSystem#ServiceModel#ICommunicationObject#Faulted (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate methodIService::AnnotationsDeleteDeletes an existing annotation.
Explicit interface implemetationPrivate methodIService::AnnotationsUpdateUpdates an existing annotation.
Explicit interface implemetationPrivate methodIService::AttributeChangeChanges an attribute.
Explicit interface implemetationPrivate methodIService::BusinessRulesCloneCreates new business rules which are exact copies of business rules from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate methodIService::BusinessRulesCreateCreates new business rules.
Explicit interface implemetationPrivate methodIService::BusinessRulesDeleteDeletes the business rule or components of rules.
Explicit interface implemetationPrivate methodIService::BusinessRulesGetRetrieves the business rules.
Explicit interface implemetationPrivate methodIService::BusinessRulesPaletteGetRetrieves the available business rule components (the component palette).
Explicit interface implemetationPrivate methodIService::BusinessRulesPublishPublishes the business rules for a model or entity or member type.
Explicit interface implemetationPrivate methodIService::BusinessRulesUpdateUpdates the existing business rules.
Explicit interface implemetationPrivate methodIService::DataQualityCleansingOperationCreateInfrastructure. Creates an operation request for DQS quality cleansing.
Explicit interface implemetationPrivate methodIService::DataQualityInstalledStateInfrastructure. Retrieves the DQS state – the response is positive if DQS is properly installed and configured to work with Master Data Services.
Explicit interface implemetationPrivate methodIService::DataQualityKnowledgeBasesGetInfrastructure. Retrieves the list of knowledgebase configured in DQS.
Explicit interface implemetationPrivate methodIService::DataQualityMatchingOperationCreateInfrastructure. Creates an operation request for DQS matching.
Explicit interface implemetationPrivate methodIService::DataQualityOperationPurgeOperationInfrastructure. Returns a purge operation for DQS operation.
Explicit interface implemetationPrivate methodIService::DataQualityOperationResultsGetInfrastructure. Retrieves the results of a completed DQS operation.
Explicit interface implemetationPrivate methodIService::DataQualityOperationStartInfrastructure. Starts a DQS operation.
Explicit interface implemetationPrivate methodIService::DataQualityOperationStatusInfrastructure. Retrieves the status of a running DQS operation.
Explicit interface implemetationPrivate methodIService::DataQualityStoreInputDataInfrastructure. Retrieves the data for the data quality store input.
Explicit interface implemetationPrivate methodIService::EntityMemberAnnotationsCreateCreates new annotations attached to a member.
Explicit interface implemetationPrivate methodIService::EntityMemberAnnotationsGetRetrieves the annotations attached to a member.
Explicit interface implemetationPrivate methodIService::EntityMemberAttributesGetRetrieves the specified set of attribute values from a specified list of members.
Explicit interface implemetationPrivate methodIService::EntityMemberKeyLookupThis 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.
Explicit interface implemetationPrivate methodIService::EntityMembersCopyCopies the selected members to new target members.
Explicit interface implemetationPrivate methodIService::EntityMembersCreateCreates new members.
Explicit interface implemetationPrivate methodIService::EntityMembersDeleteDeletes or deactivates the selected members.
Explicit interface implemetationPrivate methodIService::EntityMembersGetRetrieves the filtered set of members and their data from an entity.
Explicit interface implemetationPrivate methodIService::EntityMembersMergeCreates new members and updates existing members.
Explicit interface implemetationPrivate methodIService::EntityMembersUpdateUpdates the existing members.
Explicit interface implemetationPrivate methodIService::EntityStagingClearInfrastructure. Clears the entity staging area.
Explicit interface implemetationPrivate methodIService::EntityStagingGetInfrastructure. Retrieves the contents of the entity staging area.
Explicit interface implemetationPrivate methodIService::EntityStagingLoadInfrastructure. Loads the contents of the entity staging area.
Explicit interface implemetationPrivate methodIService::EntityStagingProcessInfrastructure. Sets the batch to be queued for processing.
Explicit interface implemetationPrivate methodIService::ExportViewCreateGenerates or regenerates the desired subscription views.
Explicit interface implemetationPrivate methodIService::ExportViewDeleteRemoves an existing export view.
Explicit interface implemetationPrivate methodIService::ExportViewListGetRetrieves the list of existing export views.
Explicit interface implemetationPrivate methodIService::ExportViewUpdateUpdates an existing export view.
Explicit interface implemetationPrivate methodIService::HierarchyMembersGetRetrieves the parent-child members from a hierarchy relative to a parent node.
Explicit interface implemetationPrivate methodIService::MetadataCloneCreates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate methodIService::MetadataCreateCreates new metadata components.
Explicit interface implemetationPrivate methodIService::MetadataDeleteDeletes the metadata components.
Explicit interface implemetationPrivate methodIService::MetadataGetRetrieves a metadata.
Explicit interface implemetationPrivate methodIService::MetadataUpdateUpdates a metadata.
Explicit interface implemetationPrivate methodIService::ModelMembersBulkDeleteBegins the asynchronous bulk deletion of members.
Explicit interface implemetationPrivate methodIService::ModelMembersBulkMergeBegins the asynchronous bulk creation and/or update of member data across one or more entities.
Explicit interface implemetationPrivate methodIService::ModelMembersBulkUpdateBegins the asynchronous bulk update of member data across one or more entities.
Explicit interface implemetationPrivate methodIService::ModelMembersGetRetrieves the entire selected models, entities and/or hierarchies.
Explicit interface implemetationPrivate methodIService::SecurityPrincipalsCloneCreates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.
Explicit interface implemetationPrivate methodIService::SecurityPrincipalsCreateCreates new users, groups and their permissions within the security model.
Explicit interface implemetationPrivate methodIService::SecurityPrincipalsDeleteDeletes user and groups.
Explicit interface implemetationPrivate methodIService::SecurityPrincipalsGetRetrieves the security principals and their permissions.
Explicit interface implemetationPrivate methodIService::SecurityPrincipalsUpdateUpdates the security principals.
Explicit interface implemetationPrivate methodIService::SecurityPrivilegesCloneCreates an exact copy of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate methodIService::SecurityPrivilegesCreateCreates the security privileges.
Explicit interface implemetationPrivate methodIService::SecurityPrivilegesDeleteDeletes the permissions.
Explicit interface implemetationPrivate methodIService::SecurityPrivilegesGetRetrieves the security permissions for selected principals and/or models.
Explicit interface implemetationPrivate methodIService::SecurityPrivilegesUpdateUpdates the security privileges.
Explicit interface implemetationPrivate methodIService::ServiceCheckDetermines whether the Master Data Services Web service is up and running and is connected to the database.
Explicit interface implemetationPrivate methodIService::ServiceVersionGetRetrieves the service version.
Explicit interface implemetationPrivate methodIService::StagingClearClears the bulk staging area.
Explicit interface implemetationPrivate methodIService::StagingGetRetrieves the contents of the bulk staging area.
Explicit interface implemetationPrivate methodIService::StagingNameCheckChecks the staging name to see if the name is unique or the name is already used.
Explicit interface implemetationPrivate methodIService::StagingProcessSweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.
Explicit interface implemetationPrivate methodIService::SystemDomainListGetRetrieves the localized fixed list of choices based on a list code.
Explicit interface implemetationPrivate methodIService::SystemPropertiesGetRetrieves the immutable properties about the system.
Explicit interface implemetationPrivate methodIService::SystemSettingsGetRetrieves the list of system settings.
Explicit interface implemetationPrivate methodIService::SystemSettingsUpdateUpdates the system setting values.
Explicit interface implemetationPrivate methodIService::TransactionAnnotationsCreateCreates new annotations attached to an existing transaction.
Explicit interface implemetationPrivate methodIService::TransactionAnnotationsGetRetrieves the filtered list of transaction annotations from a model.
Explicit interface implemetationPrivate methodIService::TransactionsGetRetrieves the filtered list of transactions from a model.
Explicit interface implemetationPrivate methodIService::TransactionsReverseReverses one or more existing transactions.
Explicit interface implemetationPrivate methodIService::UserPreferencesDeleteDeletes the current user’s preferences.
Explicit interface implemetationPrivate methodIService::UserPreferencesGetRetrieves the current user’s preferences.
Explicit interface implemetationPrivate methodIService::UserPreferencesUpdateUpdates the current user’s preferences.
Explicit interface implemetationPrivate methodIService::ValidationGetGets the validation issues for the given criteria.
Explicit interface implemetationPrivate methodIService::ValidationProcessProcesses the validations (business rules) for selected members within a model.
Explicit interface implemetationPrivate methodIService::VersionCopyCopies a model version to a new version.
Explicit interface implemetationPrivate methodSystem#ServiceModel#ICommunicationObject#Open (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate eventSystem#ServiceModel#ICommunicationObject#Opened (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate eventSystem#ServiceModel#ICommunicationObject#Opening (Inherited from ClientBase<IService>.)
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft