Service Service Service Class

Definition

Contains the various Business Rules API operations. User must have System Administration Function permission to use BusinessRulesGet. User must have System Administration Function permission and be a Model Administrator (Update at the Model level) to use all other operations.

public ref class Service sealed : Microsoft::MasterDataServices::Services::ServiceContracts::IService, System::ServiceModel::Description::IServiceBehavior
[System.ServiceModel.Activation.AspNetCompatibilityRequirements(RequirementsMode=System.ServiceModel.Activation.AspNetCompatibilityRequirementsMode.Allowed)]
[System.ServiceModel.ServiceBehavior(ConcurrencyMode=System.ServiceModel.ConcurrencyMode.Multiple, InstanceContextMode=System.ServiceModel.InstanceContextMode.Single, Namespace="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09")]
public sealed class Service : Microsoft.MasterDataServices.Services.ServiceContracts.IService, System.ServiceModel.Description.IServiceBehavior
Public NotInheritable Class Service
Implements IService, IServiceBehavior
Inheritance
ServiceServiceService
Attributes
Implements

Constructors

Service() Service() Service()

Initializes a new instance of the Service class.

Methods

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection) AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)

Provides the ability to pass custom data to binding elements to support the contract implementation.

AnnotationsDelete(AnnotationsDeleteRequest) AnnotationsDelete(AnnotationsDeleteRequest) AnnotationsDelete(AnnotationsDeleteRequest)

Deletes an existing annotations.

AnnotationsUpdate(AnnotationsUpdateRequest) AnnotationsUpdate(AnnotationsUpdateRequest) AnnotationsUpdate(AnnotationsUpdateRequest)

Updates an existing annotations.

ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) ApplyDispatchBehavior(ServiceDescription, ServiceHostBase) ApplyDispatchBehavior(ServiceDescription, ServiceHostBase)

Registers for all service operations a parameter inspector that extracts and applies WCF client locale info. Registers an error handler for all channels.

AttributeChange(AttributeChangeRequest) AttributeChange(AttributeChangeRequest) AttributeChange(AttributeChangeRequest)

Changes the name and/or the type of an attribute.

BusinessRulesClone(BusinessRulesCloneRequest) BusinessRulesClone(BusinessRulesCloneRequest) BusinessRulesClone(BusinessRulesCloneRequest)

Creates new business rules which are exact copies of business rules from another instance.

BusinessRulesCreate(BusinessRulesCreateRequest) BusinessRulesCreate(BusinessRulesCreateRequest) BusinessRulesCreate(BusinessRulesCreateRequest)

Creates new business rules.

BusinessRulesDelete(BusinessRulesDeleteRequest) BusinessRulesDelete(BusinessRulesDeleteRequest) BusinessRulesDelete(BusinessRulesDeleteRequest)

Deletes a business rule or components of rules.

BusinessRulesGet(BusinessRulesGetRequest) BusinessRulesGet(BusinessRulesGetRequest) BusinessRulesGet(BusinessRulesGetRequest)

Retrieves business rules. Must have System Administration Function permission.

BusinessRulesPaletteGet(BusinessRulesPaletteGetRequest) BusinessRulesPaletteGet(BusinessRulesPaletteGetRequest) BusinessRulesPaletteGet(BusinessRulesPaletteGetRequest)

Retrieves available business rule components (the component palette).

BusinessRulesPublish(BusinessRulesPublishRequest) BusinessRulesPublish(BusinessRulesPublishRequest) BusinessRulesPublish(BusinessRulesPublishRequest)

Publishes business rules for a model/entity/member type.

BusinessRulesUpdate(BusinessRulesUpdateRequest) BusinessRulesUpdate(BusinessRulesUpdateRequest) BusinessRulesUpdate(BusinessRulesUpdateRequest)

Updates an existing business rules.

DataQualityCleansingOperationCreate(DataQualityCleansingOperationCreateRequest) DataQualityCleansingOperationCreate(DataQualityCleansingOperationCreateRequest) DataQualityCleansingOperationCreate(DataQualityCleansingOperationCreateRequest)

Creates a cleansing operation

DataQualityInstalledState(DataQualityInstalledStateRequest) DataQualityInstalledState(DataQualityInstalledStateRequest) DataQualityInstalledState(DataQualityInstalledStateRequest)

Get the DQS state - the response is positive if DQS is properly installed and configured to work with MDS.

DataQualityKnowledgeBasesGet(DataQualityKnowledgeBasesGetRequest) DataQualityKnowledgeBasesGet(DataQualityKnowledgeBasesGetRequest) DataQualityKnowledgeBasesGet(DataQualityKnowledgeBasesGetRequest)

Gets a list of knowledge bases configured in DQS.

DataQualityMatchingOperationCreate(DataQualityMatchingOperationCreateRequest) DataQualityMatchingOperationCreate(DataQualityMatchingOperationCreateRequest) DataQualityMatchingOperationCreate(DataQualityMatchingOperationCreateRequest)

Creates a matching operation

DataQualityOperationPurgeOperation(DataQualityOperationPurgeOperationRequest) DataQualityOperationPurgeOperation(DataQualityOperationPurgeOperationRequest) DataQualityOperationPurgeOperation(DataQualityOperationPurgeOperationRequest)

Gets the results of a completed DQS operation

DataQualityOperationResultsGet(DataQualityOperationResultsGetRequest) DataQualityOperationResultsGet(DataQualityOperationResultsGetRequest) DataQualityOperationResultsGet(DataQualityOperationResultsGetRequest)

Gets the results of a completed DQS operation.

DataQualityOperationStart(DataQualityOperationStartRequest) DataQualityOperationStart(DataQualityOperationStartRequest) DataQualityOperationStart(DataQualityOperationStartRequest)

Starts an already existing DQS operation

DataQualityOperationStatus(DataQualityOperationStatusRequest) DataQualityOperationStatus(DataQualityOperationStatusRequest) DataQualityOperationStatus(DataQualityOperationStatusRequest)

Gets the status of a running DQS operation.

DataQualityStoreInputData(DataQualityStoreInputDataRequest) DataQualityStoreInputData(DataQualityStoreInputDataRequest) DataQualityStoreInputData(DataQualityStoreInputDataRequest)

Stores DQS input data on the server. Can be called multiple times for same operation

EntityMemberAnnotationDelete(EntityMemberAnnotationDeleteRequest) EntityMemberAnnotationDelete(EntityMemberAnnotationDeleteRequest) EntityMemberAnnotationDelete(EntityMemberAnnotationDeleteRequest)

Deletes an annotations related to a member revision.

EntityMemberAnnotationSave(EntityMemberAnnotationSaveRequest) EntityMemberAnnotationSave(EntityMemberAnnotationSaveRequest) EntityMemberAnnotationSave(EntityMemberAnnotationSaveRequest)

Saves an annotations related to a member revision.

EntityMemberAnnotationsCreate(EntityMemberAnnotationsCreateRequest) EntityMemberAnnotationsCreate(EntityMemberAnnotationsCreateRequest) EntityMemberAnnotationsCreate(EntityMemberAnnotationsCreateRequest)

Creates new annotations attached to a member.

EntityMemberAnnotationsGet(EntityMemberAnnotationsGetRequest) EntityMemberAnnotationsGet(EntityMemberAnnotationsGetRequest) EntityMemberAnnotationsGet(EntityMemberAnnotationsGetRequest)

Gets annotations related to a member revision.

EntityMemberAttributesGet(EntityMemberAttributesGetRequest) EntityMemberAttributesGet(EntityMemberAttributesGetRequest) EntityMemberAttributesGet(EntityMemberAttributesGetRequest)

Gets a single attribute value for a member in an entity. Designed to be able to get binary files, but you can get any attribute value you request.

EntityMemberChangesetDelete(EntityMemberChangesetDeleteRequest) EntityMemberChangesetDelete(EntityMemberChangesetDeleteRequest) EntityMemberChangesetDelete(EntityMemberChangesetDeleteRequest)

Delete an changeset

EntityMemberChangeSetDelete(EntityMemberChangeSetDeleteRequest) EntityMemberChangeSetDelete(EntityMemberChangeSetDeleteRequest) EntityMemberChangeSetDelete(EntityMemberChangeSetDeleteRequest)

Deletes a change set.

EntityMemberChangesetSave(EntityMemberChangesetSaveRequest) EntityMemberChangesetSave(EntityMemberChangesetSaveRequest) EntityMemberChangesetSave(EntityMemberChangesetSaveRequest)

Create or update an changeset

EntityMemberChangeSetSave(EntityMemberChangeSetSaveRequest) EntityMemberChangeSetSave(EntityMemberChangeSetSaveRequest) EntityMemberChangeSetSave(EntityMemberChangeSetSaveRequest)

Creates or updates a change set.

EntityMemberChangesetsGet(EntityMemberChangesetsGetRequest) EntityMemberChangesetsGet(EntityMemberChangesetsGetRequest) EntityMemberChangesetsGet(EntityMemberChangesetsGetRequest)

Get changesets

EntityMemberChangeSetsGet(EntityMemberChangeSetsGetRequest) EntityMemberChangeSetsGet(EntityMemberChangeSetsGetRequest) EntityMemberChangeSetsGet(EntityMemberChangeSetsGetRequest)

Gets change sets.

EntityMemberHistoryRollback(EntityMemberHistoryRollbackRequest) EntityMemberHistoryRollback(EntityMemberHistoryRollbackRequest) EntityMemberHistoryRollback(EntityMemberHistoryRollbackRequest)

Rolls back to the specific entity member history.

EntityMemberKeyLookup(EntityMemberKeyGetRequest) EntityMemberKeyLookup(EntityMemberKeyGetRequest) EntityMemberKeyLookup(EntityMemberKeyGetRequest)

Looks up either a memberCode or memberId based on the criteria.

EntityMembersCopy(EntityMembersCopyRequest) EntityMembersCopy(EntityMembersCopyRequest) EntityMembersCopy(EntityMembersCopyRequest)

Creates a member the same as another. Sets attribute and same location in Hierarchy.

EntityMembersCreate(EntityMembersCreateRequest) EntityMembersCreate(EntityMembersCreateRequest) EntityMembersCreate(EntityMembersCreateRequest)

Creates one or more members and sets attribute values if specified.

EntityMembersDelete(EntityMembersDeleteRequest) EntityMembersDelete(EntityMembersDeleteRequest) EntityMembersDelete(EntityMembersDeleteRequest)

Deletes one or more members.

EntityMembersGet(EntityMembersGetRequest) EntityMembersGet(EntityMembersGetRequest) EntityMembersGet(EntityMembersGetRequest)

Gets the specific entity members for the given criteria.

EntityMembersMerge(EntityMembersMergeRequest) EntityMembersMerge(EntityMembersMergeRequest) EntityMembersMerge(EntityMembersMergeRequest)

Create/update one or more members and all the attributes, collections, and relationships

EntityMembersPurge(EntityMembersPurgeRequest) EntityMembersPurge(EntityMembersPurgeRequest) EntityMembersPurge(EntityMembersPurgeRequest)

Purges soft-deleted members from a model version.

EntityMembersUpdate(EntityMembersUpdateRequest) EntityMembersUpdate(EntityMembersUpdateRequest) EntityMembersUpdate(EntityMembersUpdateRequest)

Updates one or more members.

EntityStagingClear(EntityStagingClearRequest) EntityStagingClear(EntityStagingClearRequest) EntityStagingClear(EntityStagingClearRequest)

Set the given batch (via a unique batch ID) to the "queued to clear" status

EntityStagingGet(EntityStagingGetRequest) EntityStagingGet(EntityStagingGetRequest) EntityStagingGet(EntityStagingGetRequest)

Gets the list of batches in the system for a given model.

EntityStagingLoad(EntityStagingLoadRequest) EntityStagingLoad(EntityStagingLoadRequest) EntityStagingLoad(EntityStagingLoadRequest)

Loads (in bulk) members and relationships into entity based staging tables.

EntityStagingProcess(EntityStagingProcessRequest) EntityStagingProcess(EntityStagingProcessRequest) EntityStagingProcess(EntityStagingProcessRequest)

Sets the given batch (via batch tag, entity ID, member type and version ID) to be queued for processing.

ErrorLogsGet(ErrorLogsGetRequest) ErrorLogsGet(ErrorLogsGetRequest) ErrorLogsGet(ErrorLogsGetRequest)

Gets the error log of a specific correlation ID from cache.

ExportViewCreate(ExportViewCreateRequest) ExportViewCreate(ExportViewCreateRequest) ExportViewCreate(ExportViewCreateRequest)

Creates a new export (subscription) view.

ExportViewDelete(ExportViewDeleteRequest) ExportViewDelete(ExportViewDeleteRequest) ExportViewDelete(ExportViewDeleteRequest)

Deletes an existing export (subscription) view.

ExportViewListGet(ExportViewListGetRequest) ExportViewListGet(ExportViewListGetRequest) ExportViewListGet(ExportViewListGetRequest)

Gets the list of export (subscription) view(s).

ExportViewUpdate(ExportViewUpdateRequest) ExportViewUpdate(ExportViewUpdateRequest) ExportViewUpdate(ExportViewUpdateRequest)

Updates an existing export (subscription) view.

FileGet(FileGetRequest) FileGet(FileGetRequest) FileGet(FileGetRequest)

Gets the file from cache.

FileSave(FileSaveRequest) FileSave(FileSaveRequest) FileSave(FileSaveRequest)

Saves the file into cache.

HierarchyMembersGet(HierarchyMembersGetRequest) HierarchyMembersGet(HierarchyMembersGetRequest) HierarchyMembersGet(HierarchyMembersGetRequest)

Gets the parent-child data for a given hierarchy.

HierarchyParentSave(HierarchyParentSaveRequest) HierarchyParentSave(HierarchyParentSaveRequest) HierarchyParentSave(HierarchyParentSaveRequest)

Saves the derived hierarchy parent of the given child members for the given hierarchy level.

MetadataClone(MetadataCloneRequest) MetadataClone(MetadataCloneRequest) MetadataClone(MetadataCloneRequest)

Create new metadata objects which are exact copies of metadata objects from another instance.

MetadataCreate(MetadataCreateRequest) MetadataCreate(MetadataCreateRequest) MetadataCreate(MetadataCreateRequest)

Create new metadata objects.

MetadataDelete(MetadataDeleteRequest) MetadataDelete(MetadataDeleteRequest) MetadataDelete(MetadataDeleteRequest)

Delete a various metadata objects.

MetadataGet(MetadataGetRequest) MetadataGet(MetadataGetRequest) MetadataGet(MetadataGetRequest)

Retrieve various metadata objects.

MetadataUpdate(MetadataUpdateRequest) MetadataUpdate(MetadataUpdateRequest) MetadataUpdate(MetadataUpdateRequest)

Update various metadata objects.

ModelMembersGet(ModelMembersGetRequest) ModelMembersGet(ModelMembersGetRequest) ModelMembersGet(ModelMembersGetRequest)

Gets all data in the model per the request.

SecurityDelete(SecurityDeleteRequest) SecurityDelete(SecurityDeleteRequest) SecurityDelete(SecurityDeleteRequest)

This operation deletes components of the SecuritySet

SecurityPrincipalsClone(SecurityPrincipalsRequest) SecurityPrincipalsClone(SecurityPrincipalsRequest) SecurityPrincipalsClone(SecurityPrincipalsRequest)

Creates a new security SecurityPrincipalsRequest as exact copies of objects in another MDM hub instance. This operation requires both the guid and the name of the new items in the request. The guid will be inserted rather than generated.

SecurityPrincipalsCreate(SecurityPrincipalsRequest) SecurityPrincipalsCreate(SecurityPrincipalsRequest) SecurityPrincipalsCreate(SecurityPrincipalsRequest)

Creates new security principal object in the MDM repository.

SecurityPrincipalsDelete(SecurityPrincipalsDeleteRequest) SecurityPrincipalsDelete(SecurityPrincipalsDeleteRequest) SecurityPrincipalsDelete(SecurityPrincipalsDeleteRequest)

Deletes the principals specified as part of the SecurityPrincipalsDeleteRequest.

SecurityPrincipalsGet(SecurityPrincipalsGetRequest) SecurityPrincipalsGet(SecurityPrincipalsGetRequest) SecurityPrincipalsGet(SecurityPrincipalsGetRequest)

The operation retrieves the SecuritySet data in whole or in parts. The operation returns a representative data model of the security structure and content.

SecurityPrincipalsUpdate(SecurityPrincipalsRequest) SecurityPrincipalsUpdate(SecurityPrincipalsRequest) SecurityPrincipalsUpdate(SecurityPrincipalsRequest)

Updates the security principals, collection of User and Group in the repository.

SecurityPrivilegesClone(SecurityPrivilegesRequest) SecurityPrivilegesClone(SecurityPrivilegesRequest) SecurityPrivilegesClone(SecurityPrivilegesRequest)

Create new security privileges as exact copies of privileges in another MDM hub instance.

SecurityPrivilegesCreate(SecurityPrivilegesRequest) SecurityPrivilegesCreate(SecurityPrivilegesRequest) SecurityPrivilegesCreate(SecurityPrivilegesRequest)

Creates new security privileges in the MDM repository

SecurityPrivilegesDelete(SecurityPrivilegesDeleteRequest) SecurityPrivilegesDelete(SecurityPrivilegesDeleteRequest) SecurityPrivilegesDelete(SecurityPrivilegesDeleteRequest)

Deletes the security privileges specified in the request.

SecurityPrivilegesGet(SecurityPrivilegesGetRequest) SecurityPrivilegesGet(SecurityPrivilegesGetRequest) SecurityPrivilegesGet(SecurityPrivilegesGetRequest)

Gets the security privileges from the MDM repository based on the specified get criteria.

SecurityPrivilegesUpdate(SecurityPrivilegesRequest) SecurityPrivilegesUpdate(SecurityPrivilegesRequest) SecurityPrivilegesUpdate(SecurityPrivilegesRequest)

Updates the security privileges information in the MDM repository.

ServiceCheck(ServiceCheckGetRequest) ServiceCheck(ServiceCheckGetRequest) ServiceCheck(ServiceCheckGetRequest)

Perform a service check to determine if MDS is in a healthy state.

ServiceVersionGet(ServiceVersionGetRequest) ServiceVersionGet(ServiceVersionGetRequest) ServiceVersionGet(ServiceVersionGetRequest)

Gets the version of the Service instance.

StagingNameCheck(StagingNameCheckRequest) StagingNameCheck(StagingNameCheckRequest) StagingNameCheck(StagingNameCheckRequest)

Check if the staging name is unique or the staging name is already used.

SyncRelationshipDelete(SyncRelationshipDeleteRequest) SyncRelationshipDelete(SyncRelationshipDeleteRequest) SyncRelationshipDelete(SyncRelationshipDeleteRequest)

Deletes a sync relationship between two entity versions.

SyncRelationshipMerge(SyncRelationshipMergeRequest) SyncRelationshipMerge(SyncRelationshipMergeRequest) SyncRelationshipMerge(SyncRelationshipMergeRequest)

Creates or Updates a sync relationship between two entity versions. An initial sync process will be kicked off after the relationship is established successfully.

SyncRelationshipRefresh(SyncRelationshipRefreshRequest) SyncRelationshipRefresh(SyncRelationshipRefreshRequest) SyncRelationshipRefresh(SyncRelationshipRefreshRequest)

Refreshes a sync relationship by updating the target entity version to match the source entity version.

SyncRelationshipsGet(SyncRelationshipsGetRequest) SyncRelationshipsGet(SyncRelationshipsGetRequest) SyncRelationshipsGet(SyncRelationshipsGetRequest)

Retrieves sync relationships.

SystemDomainListGet(SystemDomainListGetRequest) SystemDomainListGet(SystemDomainListGetRequest) SystemDomainListGet(SystemDomainListGetRequest)

Retrieve system domain lists.

SystemPropertiesGet(SystemPropertiesGetRequest) SystemPropertiesGet(SystemPropertiesGetRequest) SystemPropertiesGet(SystemPropertiesGetRequest)

Retrieve system properties.

SystemSettingsGet(SystemSettingsGetRequest) SystemSettingsGet(SystemSettingsGetRequest) SystemSettingsGet(SystemSettingsGetRequest)

Retrieve the system settings.

SystemSettingsUpdate(SystemSettingsUpdateRequest) SystemSettingsUpdate(SystemSettingsUpdateRequest) SystemSettingsUpdate(SystemSettingsUpdateRequest)

Update system settings.

TransactionAnnotationsCreate(TransactionAnnotationsCreateRequest) TransactionAnnotationsCreate(TransactionAnnotationsCreateRequest) TransactionAnnotationsCreate(TransactionAnnotationsCreateRequest)

Creates new annotations related to a transaction.

TransactionAnnotationsGet(TransactionAnnotationsGetRequest) TransactionAnnotationsGet(TransactionAnnotationsGetRequest) TransactionAnnotationsGet(TransactionAnnotationsGetRequest)

Get annotations related to a transaction

TransactionsGet(TransactionsGetRequest) TransactionsGet(TransactionsGetRequest) TransactionsGet(TransactionsGetRequest)

Gets the transactions for the given criteria.

TransactionsReverse(TransactionsReverseRequest) TransactionsReverse(TransactionsReverseRequest) TransactionsReverse(TransactionsReverseRequest)

Reverses one or more existing MDM Transaction(s).

UserEffectiveObjectPermissionsGet(UserEffectiveObjectPermissionsGetRequest) UserEffectiveObjectPermissionsGet(UserEffectiveObjectPermissionsGetRequest) UserEffectiveObjectPermissionsGet(UserEffectiveObjectPermissionsGetRequest)

Gets the users from the MDS repository based on the specified object permission

UserPreferencesDelete(UserPreferencesDeleteRequest) UserPreferencesDelete(UserPreferencesDeleteRequest) UserPreferencesDelete(UserPreferencesDeleteRequest)

Delete the user's preferences.

UserPreferencesGet(UserPreferencesGetRequest) UserPreferencesGet(UserPreferencesGetRequest) UserPreferencesGet(UserPreferencesGetRequest)

Retrieve all the user's preferences.

UserPreferencesUpdate(UserPreferencesUpdateRequest) UserPreferencesUpdate(UserPreferencesUpdateRequest) UserPreferencesUpdate(UserPreferencesUpdateRequest)

Update the user's preferences.

Validate(ServiceDescription, ServiceHostBase) Validate(ServiceDescription, ServiceHostBase) Validate(ServiceDescription, ServiceHostBase)

Validates the permissions.

ValidationGet(ValidationGetRequest) ValidationGet(ValidationGetRequest) ValidationGet(ValidationGetRequest)

Gets the validation issue(s) for the given criteria.

ValidationProcess(ValidationProcessRequest) ValidationProcess(ValidationProcessRequest) ValidationProcess(ValidationProcessRequest)

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

VersionCopy(VersionCopyRequest) VersionCopy(VersionCopyRequest) VersionCopy(VersionCopyRequest)

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

Applies to