Share via

  • Article

Microsoft.MasterDataServices Namespace

Contains classes that provide the main entry point for Master Data Services.

Classes

  Class Description
Public class Annotation Specifies an annotation (comment) on a transaction or member.
Public class AnnotationsCreateResponse Represents a response to an EntityMemberAnnotationsCreateRequest.
Public class AnnotationsDeleteRequest Represents a request to delete an existing annotation.
Public class AnnotationsDeleteResponse Represents a response to a request to delete an existing annotation.
Public class AnnotationsUpdateRequest Represents a request to update the comment text of an annotation.
Public class AnnotationsUpdateResponse Represents a response to a request to update the comment text of an annotation.
Public class Attribute Represents a master data attribute, including its identification and data value.
Public class AttributeGroup Represents a group of attributes.
Public class AuditInfo Represents audit information appended to numerous complex types.
Public class BRAction Represents a value creation or validation action within a created business rule.
Public class BRActionComponent Represents the action components of business rules.
Public class BRActionGroup Represents a grouping of related business rule action components currently available for use in MDS.
Public class BRArgument Represents the base type for all business rule arguments in MDS.
Public class BRAttributeArgument Represents the argument type for comparing attributes within a business rule.
Public class BRAttributeArgumentBase Represents the base complex type for business rule attribute arguments.
Public class BRAttributeTypeInfo Represents the attribute type information for business rule attributes.
Public class BRAttributeValueArgument Represents the business rule attribute free-form value set in conditions and validation actions.
Public class BRBlankArgument Represents a specialized argument for providing a blank value in conditions and validation actions.
Public class BRCondition Represents a container for conditions to be evaluated to trigger actions defined in a created business rule.
Public class BRConditionComponent Specifies condition components of business rules.
Public class BRConditionGroup specifies a group of conditions with a similar type of logical evaluator.
Public class BRConditionTreeNode Specifies a node within a possible complex logic tree in a business rule in MDS.
Public class BRDeleteCriteria Specifies lists of globally unique identifiers (GUIDs) for business rules items to be deleted.
Public class BRDomainBasedAttributeArgument Specifies the container for defining arguments based on values in related entity attributes.
Public class BRFreeformArgument Specifies the freeform argument type for business rule arguments.
Public class BRGetCriteria Specifies globally unique identifiers (GUIDs) or names of the desired model, entity, or member type.
Public class BRHierarchyArgument Specifies the business rule argument specific to parent-child relationship arguments.
Public class BRItem Represents the complete BRAction or BRCondition item with the attached logical operator.
Public class BRItemTypeComponent Specifies the base level components type of business rules.
Public class BRPublishCriteria Sets the scope of rules to be published.
Public class BRResultOptions Specifies the desired format of the returned BusinessRules type.
Public class BusinessRule Represents a business rule.
Public class BusinessRules Specifies containers for conditions and actions.
Public class BusinessRulesCloneRequest Represents a request that must include a BusinessRules type containing business rules and/or business rule components for creation in the MDS repository.
Public class BusinessRulesCreateRequest Represents a request that must include a BusinessRules type containing new business rules or business rule components for creation.
Public class BusinessRulesCreateResponse Represents a response to a request to create business rules.
Public class BusinessRulesDeleteRequest Represents a request that must include a BRDeleteCriteria containing business rule globally unique identifiers (GUIDs) and/or business rule components GUIDs for deletion.
Public class BusinessRulesGetRequest Represents a request that must have a populated BRGetCriteria.
Public class BusinessRulesGetResponse Represents a response that returns a BusinessRules type containing requested business rules or rule components.
Public class BusinessRulesPalette Represents all possible actions and conditions used for building business rules within the MDS system.
Public class BusinessRulesPaletteGetRequest Represents a request that must include a MemberType input.
Public class BusinessRulesPaletteGetResponse Represents a response that includes available conditions and actions for use in business rules.
Public class BusinessRulesPublishRequest Represents a request that may include a BRPublish criteria to limit which business rules are published. Otherwise, all business rules for all models, entities, and member types are published.
Public class BusinessRulesUpdateRequest Represents a request that must include a BusinessRules type containing business rules or business rule components and their updated properties.
Public class Collection Represents a collection of objects.
Public class DerivedHierarchy Specifies an already defined data relationship and prepares that relationship to be displayed in a hierarchical fashion.
Public class DerivedHierarchyContextIdentifier Specifies a set of identifiers for a master data model object that exists in the context of a derived hierarchy.
Public class DerivedHierarchyLevel Specifies a single level within the derived hierarchy data relationship tree.
Public class Entity Specifies a container for members and their attribute values and explicit hierarchies.
Public class EntityContextIdentifier Specifies a set of ID’s for a master data model object that exists in the context of an entity.
Public class EntityMemberAnnotationsCreateRequest Specifies the details of what is requested when creating entity member annotations.
Public class EntityMemberAnnotationsGetRequest Specifies the details of what exactly is requested.
Public class EntityMemberAnnotationsGetResponse Holds the details of the response.
Public class EntityMemberAttributesGetRequest Represents a request that can take an EntityMembers complex type.
Public class EntityMemberAttributesGetResponse Represents a response that can return an EntityMembers and an OperationResult type.
Public class EntityMemberKeyGetRequest Specifies the details of what is requested.
Public class EntityMemberKeyGetResponse Holds the response details.
Public class EntityMembers Represents a collection of members from a single entity and member type along with their context.
Public class EntityMembersCopyCriteria Represents the criteria of members to copy.
Public class EntityMembersCopyRequest Represents a request message for specifying the entity member or members to be copied in the EntityMembersCopyCriteria type.
Public class EntityMembersCopyResponse Represents a response message that contains the results of the operation.
Public class EntityMembersCreateRequest Represents a request message for specifying the entity or entities to be created in the EntityMembers type.
Public class EntityMembersCreateResponse Represents a response message that contains the results of the operation.
Public class EntityMembersDeleteRequest Represents a request message that should provide an EntityMembers complex type.
Public class EntityMembersDeleteResponse Represents a response message that should return an operation result.
Public class EntityMembersGetCriteria Represents a request complex type that defines the EntityMember criteria for the operations result set.
Public class EntityMembersGetRequest Represents a request message for specifying the criteria in the EntityMembersGetCriteria complex type for the retrieval of entity members and their attributes.
Public class EntityMembersGetResponse Represents a response message that might contain an EntityMembers complex type and might contain a EntityMembersInformation complex type and might contain an OperationResult complex type.
Public class EntityMembersInformation Represents a data response describing the EntityMembers result set that is returned in the same response.
Public class EntityMembersMergeRequest Represents a request to merge entity members.
Public class EntityMembersMergeResponse Represents a response to an EntityMembersMergeRequest.
Public class EntityMembersUpdateRequest Represents a request message for specifying the enity or entities to be updated in the EntityMembers complex type.
Public class EntityMembersUpdateResponse Represents a response message that contains the results of the operation.
Public class EntityMemberType Specifies the structure of an entity within MDS, including attributes and attribute groups.
Public class Error Represents an error.
Public class ErrorContext Represents the error context.
Public class ExplicitHierarchy Specifies a parent–child representation that requires all leaf members to be expressed once and only once.
Public class ExportView Specifies information related to the user-created view within the MDS system.
Public class ExportViewCreateRequest Specifies details of what is requested.
Public class ExportViewCreateResponse Holds details of the response to an ExportViewCreateRequest.
Public class ExportViewDeleteRequest Specifies the details of a request to delete an export view.
Public class ExportViewDeleteResponse Holds the details of the response to an ExportViewDeleteRequest.
Public class ExportViewListGetRequest Specifies the details of a request to get an export view list.
Public class ExportViewListGetResponse Hold details of the response to an ExportViewListGetRequest.
Public class ExportViewUpdateRequest Specifies the details of a request to update an export view.
Public class ExportViewUpdateResponse Holds details of the response to an ExportViewUpdateRequest.
Public class FileAttribute Represents a file attribute.
Public class FunctionPrivilege Specifies a function privilege security assignment for a user or group.
Public class FunctionPrivilegesCriteria Specifies criteria for function privileges.
Public class Group Represents an internal system object that refers to one or more users that can be granted security privileges within MDS.
Public class HierarchyMemberPrivilege Specifies a hierarchy member privilege security assignment for a user or group.
Public class HierarchyMemberPrivilegesCriteria Specifies criteria for hierarchy member privileges.
Public class HierarchyMembers Provides hierarchy member information that is used by other classes.
Public class HierarchyMembersGetCriteria Represents criteria for getting hierarchy members.
Public class HierarchyMembersGetRequest Represents a request message by using HierarchyMembersGetCriteria complex type to specify inputs to the request.
Public class HierarchyMembersGetResponse Represents a response that can return HierarchyMembers complex type and can return an OperationResult complex type.
Public class Identifier Represents an identifier.
Public class International Represents the data contract for the international message header.
Public class MdmDataContractOfDerivedHierarchyContextIdentifier
Public class MdmDataContractOfEntityContextIdentifier Specifies a data contract for EntityContextIdentifier.
Public class MdmDataContractOfIdentifier Specifies the data contract for identifiers including helper types such as AuditInfo and Permission.
Public class MdmDataContractOfMemberTypeContextIdentifier Specifies a data contract for MemberTypeContextIdentifier.
Public class MdmDataContractOfModelContextIdentifier Retrieves the contract of the model context ID.
Public class Member Specifies a master data member or row of data.
Public class MemberIdentifier Specifies a set of IDs for a master data member, including the code and name of the member and the MemberType.
Public class MemberKey Holds either the member code, the internal ID, or both for a member.
Public class MemberSourceTarget Represents the member codes of the source and target members to be copied.
Public class MemberTypeContextIdentifier Specifies a set of IDs for a master data model object that exists in the context of an entity and member type.
Public class MessageResponse Represents a response to an MDS message.
Public class Metadata Specifies a superset of all container objects within the MDS system.
Public class MetadataAttribute Represents a metadata attribute.
Public class MetadataCloneRequest Defines the message contract for the metadata clone request.
Public class MetadataCloneResponse Defines the message contract for the metadata clone response.
Public class MetadataCreateRequest Defines the message contract for the metadata create request.
Public class MetadataCreateResponse Defines the message contract for the metadata create response.
Public class MetadataDeleteRequest Defines the message contract for the metadata delete request.
Public class MetadataDeleteResponse Defines the message contract for the metadata delete response.
Public class MetadataGetRequest Selects metadata objects at the specified level of detail.
Public class MetadataGetResponse Defines the message contract for the metadata get response.
Public class MetadataResultOptions Specifies the results of a metadata get operation to return.
Public class MetadataSearchCriteria Specifies the MetadataGet search (filter) criteria.
Public class MetadataUpdateRequest Defines the message contract for the metadata update request.
Public class MetadataUpdateResponse Defines the message contract for the metadata update response.
Public class Model Represents a model, which is the highest grouping of MDS entities.
Public class ModelContextIdentifier Represents a set of Identifiers for a master data model object that exists in the context of a model.
Public class ModelMembersBulkDeleteRequest Represents a request to delete model members in bulk.
Public class ModelMembersBulkDeleteResponse Represents a response to a request to delete model members in bulk.
Public class ModelMembersBulkMergeRequest Represents a request to merge model members in bulk.
Public class ModelMembersBulkMergeResponse Represents a response to a request to merge model members in bulk.
Public class ModelMembersBulkUpdateRequest Represents a request to update model members in bulk.
Public class ModelMembersBulkUpdateResponse Represents a response to a request to update model members in bulk.
Public class ModelMembersGetCriteria Specifies criteria for getting model members.
Public class ModelMembersGetRequest Represents a request message for specifying the criteria in the ModelMembersGetCriteria complex type for the retrieval of the model.
Public class ModelMembersGetResponse Represents a response that can contain an array of entity members and can contain an OperationResult.
Public class ModelMembersResultCriteria Specifies the format and level of detail for getting model members.
Public class ModelPrivilege Specifies a model/object level privilege within the MDS system.
Public class ModelPrivilegesCriteria Specifies criteria for model privileges.
Public class OperationResult Specifies a standard container for all operation responses that includes a list of errors.
Public class Parent Represents a consolidated node in a hierarchy.
Public class ParentChild Specifies a parent-child relationship record from a hierarchy.
Public class ReplacementId Defines an individual transaction that was replaced during the operation, including prior and new identifiers.
Public class SecurityCreateResponse Represents a security create response message contract.
Public class SecurityPrincipals Specifies a set of users and user groups.
Public class SecurityPrincipalsCriteria Represents the security principal criteria to be used with security get operations.
Public class SecurityPrincipalsDeleteCriteria Represents the criteria data contract for filtering security principals to be deleted through MDS.
Public class SecurityPrincipalsDeleteRequest Represents a request message for specifying the criteria in SecurityPrincipalsDeleteCriteria for the retrieval of security principals.
Public class SecurityPrincipalsGetRequest Represents a request message contract to retrieve security principals from MDS.
Public class SecurityPrincipalsGetResponse Represents a message contract for the MDS security get response.
Public class SecurityPrincipalsRequest Represents the request message contract for security principals.
Public class SecurityPrivileges Specifies a set of security privilege assignments at the function, model object, and member levels.
Public class SecurityPrivilegesDeleteCriteria Specifies criteria for deleting security privileges.
Public class SecurityPrivilegesDeleteRequest Represents a request message for specifying the criteria in SecurityPrivilegesDeleteCriteria for the deletion of security privileges.
Public class SecurityPrivilegesGetCriteria Represents criteria for specifying the types of security privileges to return.
Public class SecurityPrivilegesGetRequest Represents a request message for specifying the criteria in SecurityPrivilegesGetCriteria for the retrieval of security privileges.
Public class SecurityPrivilegesGetResponse Represents a response message that returns an operation result and a SecurityPrivileges instance that contains the returned security privileges.
Public class SecurityPrivilegesRequest Represents a request message for specifying the security privileges for the operation.
Public class SecuritySet Defines the data contract for the security search criteria.
Public class ServiceCheckGetRequest Defines the message contract for the service check get request.
Public class ServiceClient Contains the various business rules API operations.
Public class StagingBatch Specifies a container for a staging batch including the batch identification, errors, statistics, and members.
Public class StagingBatchError Specifies a process error that is associated with a member in a staging batch.
Public class StagingBatchInformation Specifies a read-only container for statistical information about a staging batch including row counts, data source, and prior batch.
Public class StagingClearRequest Represents a request message for specifying the array of batches to clear.
Public class StagingClearResponse Represents a response message that specifies counts for the batches and attribute, member, and relationship records cleared.
Public class StagingGetRequest Specifies the criteria in StagingResultCriteria for the retrieval of staging information.
Public class StagingGetResponse Represents a response that contains an operation result and an array that contains staging batch information.
Public class StagingProcessRequest Specifies the details of the staging process request.
Public class StagingProcessResponse Holds the details of staging process response.
Public class StagingResultCriteria Defines the criteria for staging batch categories.
Public class StagingSearchCriteria Defines the criteria for staging batch types.
Public class StagingUnbatchedCriteria Specifies staging unbatched criteria.
Public class StagingUnbatchedInformation Specifies a read-only container for counts of unbatched staging records for a model.
Public class SystemDomainList Represents a system domain list.
Public class SystemDomainListGetCriteria Captures query criteria for system domain lists.
Public class SystemDomainListGetRequest Defines the message contract for the system domain list get request.
Public class SystemDomainListGetResponse Provides domain list results.
Public class SystemDomainListItem Represents an item in a system domain list.
Public class SystemPropertiesGetRequest Defines the message contract for the system properties get request.
Public class SystemPropertiesGetResponse Retrieves system property values in an array.
Public class SystemPropertyValue Represents system properties and their values.
Public class SystemSetting Specifies a single setting within the MDS system.
Public class SystemSettingGroup Specifies a group of related system settings that manage system level functionality within MDS.
Public class SystemSettingsGetCriteria Identifies a system settings group for retrieval.
Public class SystemSettingsGetRequest Defines the message contract for the system setting get request.
Public class SystemSettingsGetResponse Provides system settings within a SystemSettingsGroup.
Public class SystemSettingsUpdateRequest Provides an array of one or more groups of one or more system settings to be updated.
Public class SystemSettingsUpdateResponse Defines the message contract for the system setting update response.
Public class Transaction Represents any master data changes along with user and time information that is associated with the change.
Public class TransactionAnnotationsCreateRequest Specifies details of what is requested in the operation.
Public class TransactionAnnotationsGetRequest Specifies details of what is requested about annotations that are related to a transaction.
Public class TransactionAnnotationsGetResponse Holds the details of the response to TransactionAnnotationsGetRequest.
Public class TransactionSearchCriteria Defines the transaction criteria for the operations result set.
Public class TransactionsGetRequest Specifies the criteria in TransactionSearchCriteria for the retrieval of transactions.
Public class TransactionsGetResponse Retrieves an operation result, the total number of transaction records returned, and an array that contains the returned transactions.
Public class TransactionsReverseRequest Specifies the transactions, by ID, to reverse.
Public class TransactionsReverseResponse Retrieves an operation result and an array that contains the reversed transactions.
Public class User Specifies an active directory user who has specific privileges assigned either inherited from an Active Directory group or directly assigned permissions.
Public class UserPreferencesDeleteRequest Defines the message contract for the user preferences delete request.
Public class UserPreferencesDeleteResponse Defines the message contract for the user preferences delete response.
Public class UserPreferencesGetRequest Defines the message contract for the user preferences delete response.
Public class UserPreferencesGetResponse Retrieves an array of key-value pairs that represent the user preference settings and their current values.
Public class UserPreferencesUpdateRequest Defines the message contract for the user preferences update request.
Public class UserPreferencesUpdateResponse Defines the message contract for the user preferences update response.
Public class ValidationGetRequest Describes what validation information is requested.
Public class ValidationGetResponse Holds the response values for the validation get request.
Public class ValidationIssue Specifies a validation issue recorded against, and a master data member and attribute based on a validation business rule.
Public class ValidationProcessCriteria Specifies the validation process criteria for members to be validated.
Public class ValidationProcessOptions Specifies validation process options, namely, whether to commit the version after validation, and whether to return the validation results.
Public class ValidationProcessRequest Specifies the validation process criteria and options.
Public class ValidationProcessResponse Holds the response values back from the validation process.
Public class ValidationProcessResult Holds validation process results.
Public class ValidationSearchCriteria Specifies search criteria for a validation get request.
Public class ValidationSummaryItem Describes the validation summary information.
Public class Version Specifies a snapshot that contains all model members, attributes, hierarchies and collections for a model, usually denoting a specific time period.
Public class VersionCopyRequest Defines the message contract for the version copy request.
Public class VersionCopyResponse Defines the message contract for the version copy response.
Public class VersionFlag Specifies tags that provide a standard identifier that can be attached to a version to reduce integration rework.

Interfaces

  Interface Description
Public interface IService Contains the various business rules API operations.
Public interface IServiceChannel Defines the service contract for WCF-based interactions with Master Data Services.

Enumerations

  Enumeration Description
Public enumeration AttributeDataType Contains values specifying the attribute data type.
Public enumeration AttributeType Contains values specifying the attribute type.
Public enumeration AttributeValueType Contains values specifying the data type of an attribute.
Public enumeration BREntityMemberType Represents the type of entity member associated with a business rule.
Public enumeration BRItemType Contains values specifying the selected business rule condition or action.
Public enumeration BRPropertyName Represents the name identifying a property within a business rule component.
Public enumeration BRStatus Contains values specifying the update and publication status of a business rule.
Public enumeration DisplayType Contains values that specify the chosen display format for domain-based attribute (DBA) columns.
Public enumeration EmailFormat Contains values that specify the e-mail delivery format that is associated with a user.
Public enumeration ExportViewFormat Contains values that specify the type of export view format.
Public enumeration FunctionalArea Represents the MDS application functional area.
Public enumeration GroupType Contains values that specify the type (source) of a security group.
Public enumeration HierarchyItemType Contains values that specify the type of component used by a level of a derived hierarchy.
Public enumeration HierarchyType Contains values specifying the type of hierarchy construct.
Public enumeration LogicalOperator Joins multiple business rule conditions.
Public enumeration MemberKeyLookupType Contains values that specify the type of key supplied in a member lookup.
Public enumeration MemberReturnOption Contains values that determine which member data is returned when querying master data members.
Public enumeration MemberType Contains values that specify the type of member record within an entity.
Public enumeration ModelObjectType Contains values that specify the model permission types.
Public enumeration ObjectType Contains values that specify the type of an MDS model object.
Public enumeration Permission Contains values specifying the permission assigned to a principal for accessing an MDS function, object, or data member.
Public enumeration PermissionType Contains values that specify the effective permission assigned to a principal for accessing an MDS object.
Public enumeration PrincipalType Contains values that specify the type of security principal (user or group).
Public enumeration RelationshipType Contains values that specify the type of hierarchy relationship between members.
Public enumeration ResultType Contains values that specify the level of detail to return for model object queries.
Public enumeration SearchOption Contains values specifying the scope of metadata objects to be searched.
Public enumeration SecurityPermission Contains values that specify the effective security permission for a user of a Master Data Services object.
Public enumeration SecurityResolutionType Contains values that specify the resolution when returning security permissions.
Public enumeration SortDirection Contains values that specify the sort direction of a sorted column.
Public enumeration StagingBatchStatus Contains values specifying the processing status of a staging (import) batch.
Public enumeration StagingDataStatus Contains values that indicate the success or failure of staging records.
Public enumeration SystemPropertyType Contains values that specifies the identifying name of one of the available system properties.
Public enumeration TransactionType Contains values that specify the type of member change identified in a transaction.
Public enumeration ValidationStatus Contains values that specify the validation status of a master data member.
Public enumeration VersionStatus Contains values specifying the status of a version.
Public enumeration VersionValidationStatus Contains values that specify the validation status of a version.