Service Class

Definition

Namespace:

Microsoft.MasterDataServices.Services

Assembly:

Microsoft.MasterDataServices.Services.dll

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

[<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")>]
type Service = class
    interface IService
    interface IServiceBehavior

Public NotInheritable Class Service
Implements IService, IServiceBehavior

Inheritance

Object

Service

Attributes

AspNetCompatibilityRequirementsAttribute ServiceBehaviorAttribute

Implements

IService IServiceBehavior

Constructors

Service()

Initializes a new instance of the Service class.

Properties

DatabaseSKU

Database SKU

Methods

AddBindingParameters(ServiceDescription, ServiceHostBase, Collection<ServiceEndpoint>, BindingParameterCollection)	Does nothing. See documentation for details about when this method is called and its parameters.
AnnotationsDelete(AnnotationsDeleteRequest)	Deletes existing Annotations
AnnotationsUpdate(AnnotationsUpdateRequest)	Updates existing Annotations
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)	Changes the name and/or the type of an attribute
BusinessRulesClone(BusinessRulesCloneRequest)	Create new business rules which are exact copies of business rules from another instance.
BusinessRulesCreate(BusinessRulesCreateRequest)	Create new business rules.
BusinessRulesDelete(BusinessRulesDeleteRequest)	Delete a business rule or components of rules.
BusinessRulesGet(BusinessRulesGetRequest)	Retrieve business rules. Must have System Administration Function permission
BusinessRulesPaletteGet(BusinessRulesPaletteGetRequest)	Retrieve available business rule components (the component palette).
BusinessRulesPublish(BusinessRulesPublishRequest)	Publish business rules for a model / entity / member type.
BusinessRulesUpdate(BusinessRulesUpdateRequest)	Update existing business rules.
DataQualityCleansingOperationCreate(DataQualityCleansingOperationCreateRequest)	Creates a cleansing operation
DataQualityInstalledState(DataQualityInstalledStateRequest)	Get the DQS state - the response is positive if DQS is properly installed and configured to work with MDS
DataQualityKnowledgeBasesGet(DataQualityKnowledgeBasesGetRequest)	Gets a list of knowledgebases configured in DQS
DataQualityMatchingOperationCreate(DataQualityMatchingOperationCreateRequest)	Creates a matching operation
DataQualityOperationPurgeOperation(DataQualityOperationPurgeOperationRequest)	Gets the results of a completed DQS operation
DataQualityOperationResultsGet(DataQualityOperationResultsGetRequest)	Gets the results of a completed DQS operation
DataQualityOperationStart(DataQualityOperationStartRequest)	Starts an already existing DQS operation
DataQualityOperationStatus(DataQualityOperationStatusRequest)	Gets the status of a running DQS operation
DataQualityStoreInputData(DataQualityStoreInputDataRequest)	Stores DQS input data on the server. Can be called multiple times for same operation
EntityMemberAnnotationDelete(EntityMemberAnnotationDeleteRequest)	Delete an annotations related to a member revision
EntityMemberAnnotationSave(EntityMemberAnnotationSaveRequest)	Create or update an annotations related to a member revision
EntityMemberAnnotationsCreate(EntityMemberAnnotationsCreateRequest)	Obsolete. Create new Annotations related to a member
EntityMemberAnnotationsGet(EntityMemberAnnotationsGetRequest)	Get annotations related to a member revision
EntityMemberAttributesGet(EntityMemberAttributesGetRequest)	Get 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)	Delete an changeset
EntityMemberChangesetSave(EntityMemberChangesetSaveRequest)	Create or update an changeset
EntityMemberChangesetsGet(EntityMemberChangesetsGetRequest)	Get changesets
EntityMemberHistoryRollback(EntityMemberHistoryRollbackRequest)	EntityMemberHistoriesGet is a service that return the specific entity member history
EntityMemberKeyLookup(EntityMemberKeyGetRequest)	Looks up either a memberCode or memberId based on the criteria.
EntityMembersCopy(EntityMembersCopyRequest)	Create a member the same as another. Set attribute and same location in Hierarchy.
EntityMembersCreate(EntityMembersCreateRequest)	Create one or members and set attribute values if specified.
EntityMembersDelete(EntityMembersDeleteRequest)	Delete one or more members
EntityMembersGet(EntityMembersGetRequest)	MembersGet is a service that gets the specific entity members for the given criteria
EntityMembersMerge(EntityMembersMergeRequest)	Create/update one or more members and all the attributes, collections, and relationships
EntityMembersPurge(EntityMembersPurgeRequest)	Purges soft-deleted members from a model version.
EntityMembersUpdate(EntityMembersUpdateRequest)	Update one or more members
EntityStagingClear(EntityStagingClearRequest)	Set the given batch (via a unique batch ID) to the "queued to clear" status
EntityStagingGet(EntityStagingGetRequest)	Used to get the list of batches in the system for a given model
EntityStagingLoad(EntityStagingLoadRequest)	Used for bulk loading of members and relationships into entity based staging tables.
EntityStagingProcess(EntityStagingProcessRequest)	Set the given batch (via batch tag, entity ID, member type and version ID) to be queued for processing
ErrorLogsGet(ErrorLogsGetRequest)	Get the error log of a specific correlation id from cache.
ExportViewCreate(ExportViewCreateRequest)	Creates a new export(subscription) view
ExportViewDelete(ExportViewDeleteRequest)	Deletes an existing export(subscription) view
ExportViewListGet(ExportViewListGetRequest)	Gets the list of export(subscription) view(s)
ExportViewUpdate(ExportViewUpdateRequest)	Updates an existing export(subscription) view
FileGet(FileGetRequest)	Get the file from cache
FileSave(FileSaveRequest)	Save the file into cache
HierarchyMembersGet(HierarchyMembersGetRequest)	HierarchyGet gets the ParentChild data for a given Hierarchy
HierarchyParentSave(HierarchyParentSaveRequest)	Changes the derived hierarchy parent of the given child members for the given hierarchy level.
MetadataClone(MetadataCloneRequest)	Create new metadata objects which are exact copies of metadata objects from another instance.
MetadataCreate(MetadataCreateRequest)	Create new metadata objects.
MetadataDelete(MetadataDeleteRequest)	Delete a various metadata objects.
MetadataGet(MetadataGetRequest)	Retrieve various metadata objects.
MetadataUpdate(MetadataUpdateRequest)	Update various metadata objects.
ModelMembersGet(ModelMembersGetRequest)	Get all data in the model per the request
SecurityPrincipalsClone(SecurityPrincipalsRequest)	Creates a new security SecurityPrincipalsRequest as exact copies of objects in another MDS 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)	Creates new security principal object in the MDS repository.
SecurityPrincipalsDelete(SecurityPrincipalsDeleteRequest)	Deletes the principals specified as part of the SecurityPrincipalsDeleteRequest.
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)	Updates the security principals, collection of User and Group in the repository.
SecurityPrivilegesClone(SecurityPrivilegesRequest)	Create new security privileges as exact copies of privileges in another MDS hub instance.
SecurityPrivilegesCreate(SecurityPrivilegesRequest)	Creates new security privileges in the MDS repository
SecurityPrivilegesDelete(SecurityPrivilegesDeleteRequest)	Deletes the security privileges specified in the request.
SecurityPrivilegesGet(SecurityPrivilegesGetRequest)	Gets the security privileges from the MDS repository based on the specified get criteria.
SecurityPrivilegesUpdate(SecurityPrivilegesRequest)	Updates the security privileges information in the MDS repository.
ServiceCheck(ServiceCheckGetRequest)	Perform a service check to determine if MDS is in a healthy state.
ServiceVersionGet(ServiceVersionGetRequest)	Gets the version of the Service instance.
StagingNameCheck(StagingNameCheckRequest)	Check if the staging name is unique or the staging name is already used.
SyncRelationshipDelete(SyncRelationshipDeleteRequest)	Deletes a sync relationship between two entity versions.
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)	Refreshes a sync relationship by updating the target entity version to match the source entity version.
SyncRelationshipsGet(SyncRelationshipsGetRequest)	Retrieves sync relationships.
SystemDomainListGet(SystemDomainListGetRequest)	Retrieve system domain lists.
SystemPropertiesGet(SystemPropertiesGetRequest)	Retrieve system properties.
SystemSettingsGet(SystemSettingsGetRequest)	Retrieve the system settings.
SystemSettingsUpdate(SystemSettingsUpdateRequest)	Update system settings.
TransactionAnnotationsCreate(TransactionAnnotationsCreateRequest)	Create new Annotations related to a transaction
TransactionAnnotationsGet(TransactionAnnotationsGetRequest)	Get annotations related to a transaction
TransactionsGet(TransactionsGetRequest)	Gets the transactions for the given criteria.
TransactionsReverse(TransactionsReverseRequest)	Reverses the MDM Transaction(s)
UserEffectiveObjectPermissionsGet(UserEffectiveObjectPermissionsGetRequest)	Gets the users from the MDS repository based on the specified object permission
UserPreferencesDelete(UserPreferencesDeleteRequest)	Delete the user's preferences.
UserPreferencesGet(UserPreferencesGetRequest)	Retrieve all the user's preferences.
UserPreferencesUpdate(UserPreferencesUpdateRequest)	Update the user's preferences.
Validate(ServiceDescription, ServiceHostBase)	Does nothing. See documentation for details about when this method is called and its parameters.
ValidationGet(ValidationGetRequest)	Gets the Validation issue(s) for the given criteria
ValidationProcess(ValidationProcessRequest)	Validates the data for the given criteria
VersionCopy(VersionCopyRequest)	Make a copy of a version, which includes making a copy of all entity member data.