Namespace Microsoft.MasterDataServices

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

Classes

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

Interfaces

	Interface	Descrição
	IService	Contains the various business rules API operations.
	IServiceChannel	Defines the service contract for WCF-based interactions with Master Data Services.

Enumerações

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