Share via

Microsoft.MasterDataServices.Services.DataContracts Namespace

  • Article

Provides a common location for data contract namespace constants. As new versions are released with modified data contracts, new constants should be added.

Classes

  Class Description
Public class Annotation Represents an annotation.
Public class Attribute Represents a master data attribute including its identification and data value.
Public class AttributeGroup Defines the data contract for the attribute group.
Public class AuditInfo Defines the data contract for the audit information which contains created by and updated by information.
Public class BRAction Represents an action argument within a created business rule.
Public class BRActionComponent Represents an action component of business rules.
Public class BRActionGroup Represents a group of related business rules action components currently available for use in Master Data Services.
Public class BRArgument Represents the base class for all business rule arguments. This class is abstract.
Public class BRAttributeArgument Represents an attribute argument that cannot have child arguments.
Public class BRAttributeArgumentBase Represents the base class for arguments that reference attributes. This class is abstract.
Public class BRAttributeTypeInfo Represents the type information for business rule attributes.
Public class BRAttributeValueArgument Represents a business rule attribute value argument.
Public class BRBlankArgument Represents a specialized argument for providing blank as a value in conditions and validation action.
Public class BRCondition Represents the conditions to be evaluated to trigger actions defined in a created business rule.
Public class BRConditionComponent Represents a rule item type component that is a condition.
Public class BRConditionGroup Represents a group of condition components of business rules.
Public class BRConditionTreeNode Represents a logical operator group for conditions.
Public class BRDeleteCriteria Represents the criteria for the delete operation.
Public class BRDomainBasedAttributeArgument Represents an attribute argument that has a child attribute argument.
Public class BRFreeformArgument Represents a business rule free-form argument.
Public class BRGetCriteria Represents the criteria for the Get operation.
Public class BRHierarchyArgument Represents a hierarchy argument that must have a child attribute argument.
Public class BRItem Represents a base class for actions and conditions.
Public class BRItemTypeComponent Represents an abstract base class for item type components (condition and action items).
Public class BRPublishCriteria Represents the criteria for the Publish operation.
Public class BRResultOptions Identifies the level of detail desired from the Get operation for each of the internal BusinessRuleSet collections.
Public class BusinessRule Represents a business rule.
Public class BusinessRuleSet Represents a business rule set.
Public class BusinessRulesPalette Represents a collection of all possible actions and conditions used for building business rules within the MDS system.
Public class Collection Represents a collection of data contracts.
Public class DataContractBase Represents a base class for all data contracts.
Public class DataContractNamespace Provides a common location for data contract namespace constants. As new versions are released with modified data contracts, new constants should be added.
Public class DataQualityDomain Infrastructure. Represents the data quality domain.
Public class DataSourceFieldMapping Infrastructure. Represents the field mapping for the data source.
Public class DateMatchingCriterion Infrastructure. Represents the criteria for date matching.
Public class DerivedHierarchy Defines the data contract for the derived hierarchy.
Public class DerivedHierarchyContextIdentifier Defines the data contract for the derived hierarchy context identifier. An object with the identifier resides within the context of a derived hierarchy.
Public class DerivedHierarchyLevel Defines the data contract for the derived hierarchy level.
Public class EditionExpiredMessage Represents the message displayed when the edition has expired.
Public class Entity Defines the data contract for the entity.
Public class EntityContextIdentifier Defines the data contract for the entity context identifier. An object with the identifier resides within the context of an entity.
Public class EntityMembers Represents the entity members of the data contract.
Public class EntityMembersCopyCriteria Represents the criteria of members to copy.
Public class EntityMembersGetCriteria Represents the criteria to get members.
Public class EntityMembersInformation Represents a complex type data response returned to describe the EntityMembers result set that is returned in the same response.
Public class EntityMemberType Represents a structure of an entity within MDS including Attributes and attribute groups.
Public class EntityStagingBatch Infrastructure. Identifies a unique batch awaiting or undergoing entity based staging.
Public class EntityStagingBatchCriteria Infrastructure. Represents a criteria of a unique batch awaiting or undergoing entity based staging.
Public class EntityStagingGetCriteria Infrastructure. Represents the criteria that determine the behavior of the EntityStagingGet service call.
Public class Error Represents a data contracts error message.
Public class ErrorContext Represents the context of errors.
Public class ExactMatchingCriterion Infrastructure. Represents the criteria for exact matching.
Public class ExplicitHierarchy Defines the data contract for the explicit hierarchy.
Public class ExportView Represents the information related to the user-created view within the Master Data Services system. These views are created to provide simplified SQL access to the data stored in the Master Data Services system in a number of common formats.
Public class FileAttribute Represents the attribute of file.
Public class FunctionPrivilege Defines a data contract for the function permissions.
Public class FunctionPrivilegesCriteria Represents the criteria for function privileges.
Public class Group Defines the data contract for the group.
Public class HierarchyMemberPrivilege Defines the data contract for the hierarchy member permission.
Public class HierarchyMemberPrivilegesCriteria Represents the criteria for hierarchy member privileges.
Public class HierarchyMembers Represents a class used by HierarchyMembersGet.
Public class HierarchyMembersGetCriteria Represents the criteria that are used by HierarchyMembersGet.
Public class Identifier Defines the data contract for the base identifier of an object.
Public class International Represents the data contract for the international message header, as per the working draft standard for Web Services Internationalization WS-I18N.
Public class Knowledgebase Infrastructure. Represents the knowledge base.
Public class MatchingCriterion Infrastructure. Represents the criteria for matching.
Public class MatchingPolicy Infrastructure. Represents the matching policy for the service.
Public class MatchingRule Infrastructure. Specifies a single rule in a matching policy.
Public class MdmDataContract<TIdType> Defines the base data contract.
Public class Member Represents a master data member or row of data used to store the member related information.
Public class MemberAttributeIdentifier Defines the data contract for the member attribute identifier. An object with the identifier resides within the context of a member type and an attribute.
Public class MemberIdentifier Defines the data contract for the member identifier.
Public class MemberKey Represents a class used in the EntityMemberKeyGet operation.
Public class MemberSourceTarget Represents a MemberSourceTarget complex type containing members to be copied.
Public class MemberTypeContextIdentifier Defines the data contract for the member type context identifier. An object with the identifier resides within the context of a member type.
Public class Metadata Defines the data contract for metadata, which is used in several metadata API requests and responses.
Public class MetadataAttribute Defines the data contract for the metadata attribute.
Public class MetadataResultOptions Defines the data contract for MetadataResultOptions.
Public class MetadataSearchCriteria Represents the criteria for the MetadataGet operation. Each parameter is optional; those specified are combined with an AND. Leave all parameters empty to get all metadata.
Public class Model Defines the data contract for the model.
Public class ModelContextIdentifier Defines the data contract for the model context identifier. An object with the identifier resides within the context of a model.
Public class ModelMembersGetCriteria Represents a class used by ModelMembersGet.
Public class ModelMembersResultCriteria Represents criteria for model member results.
Public class ModelPrivilege Defines the data contract for the model permission.
Public class ModelPrivilegesCriteria Defines the data contract for the security result criteria.
Public class NumericByDifferenceMatchingCriterion Infrastructure. Represents the criteria for matching numeric by difference.
Public class NumericByPercentageMatchingCriterion Infrastructure. Represents the criteria for matching numeric by percentage.
Public class NumericMatchingCriterion Infrastructure. Represents the criteria for numeric matching.
Public class OperationResult Represents a standard container for all operation responses that includes a list of errors.
Public class Parent Represents a parent member used by all the member related operations.
Public class ParentChild Represents a parent-child relationship record from a hierarchy.
Public class PrerequisiteMatchingCriterion Infrastructure. Represents the criteria for prerequisite matching.
Public class ReplacementId Represents a response complex type that defines an individual Transaction that was replaced during the operation, including prior and new identifiers.
Public class SecurityDeleteCriteria Defines the data contract for the security delete criteria.
Public class SecurityPrincipals Defines the data contract for the security principals.
Public class SecurityPrincipalsCriteria Defines the data contract for the security principals criteria.
Public class SecurityPrincipalsDeleteCriteria Represents the criteria data contract for filtering security principals to be deleted through the Master Data Services API.
Public class SecurityPrivileges Defines the data contract for the security search criteria.
Public class SecurityPrivilegesDeleteCriteria Represents the criteria data contract for security privileges in the Master Data Services API.
Public class SecurityPrivilegesGetCriteria Represents the data contract for security privileges retrieval criteria in the Master Data Services API.
Public class SecurityResultOptions Defines the data contract for the security results options.
Public class SecuritySet Defines the data contract for the security search criteria.
Public class SimilarMatchingCriterion Infrastructure. Represents the criteria for similar matching.
Public class StagingBatch Represents a container used to store all the staging batch information.
Public class StagingBatchError Represents the error information for a batch.
Public class StagingBatchInformation Represents a read-only container for statistical information about a staging batch including row counts, data source, and prior batch.
Public class StagingResultCriteria Represents the criteria for the staging batch result.
Public class StagingSearchCriteria Defines the criteria for staging batch types.
Public class StagingUnbatchedCriteria Represents the criteria used to identify records to be placed into a new batch.
Public class StagingUnbatchedInformation Represents the summary information about the unbatched records in the system.
Public class StringMatchingCriterion Infrastructure. Represents the criteria for string matching.
Public class SystemDomainList Defines the data contract for a system domain list.
Public class SystemDomainListGetCriteria Represents the criteria for the SystemDomainListGet operation.
Public class SystemDomainListItem Defines the data contract for a system domain list item.
Public class SystemPropertyValue Defines the data contract for system properties.
Public class SystemSetting Represents a single setting within the Master Data Manager system. These settings should be members of a SystemSettingGroup.
Public class SystemSettingGroup Defines the data contract for a system setting group. Related system settings are placed in the same group.
Public class SystemSettingsGetCriteria Represents the criteria of a system settings group for retrieval.
Public class TabularColumnDefinition Infrastructure. Describes a single column in a tabular data.
Public class TabularData Infrastructure. Represents rows and columns of data.
Public class TabularDataRow Infrastructure. Represents a single row of data in a tabular data.
Public class Transaction Represents any master data changes along with user and time information that is associated with the change.
Public class TransactionSearchCriteria Represents the criteria used to get the Master Data Manager transactions.
Public class User Defines the data contract for the user object.
Public class ValidationIssue Represents a validation issue recorded against a master data member and attribute based on a validation business rule.
Public class ValidationProcessCriteria Represents the criteria for the validation process.
Public class ValidationProcessOptions Represents the validation process options.
Public class ValidationProcessResult Represents the result of a validation process.
Public class ValidationSearchCriteria Represents the criteria when searching for validation issues.
Public class ValidationSummaryItem Represents the summary information related to the data that was validated.
Public class Version Defines the data contract for the version. Member data is associated with a version.
Public class VersionFlag Defines the data contract for the version flag.
Public class WeightedMatchingCriterion Infrastructure. Represents the criteria for weighted matching.

Interfaces

  Interface Description
Public interface IBRArgument Represents the interface for all business rule arguments.
Public interface IBRAttributeArgumentContainer Represents an interface for BRArguments that contain an attribute argument, either as the argument itself or as a child argument.
Public interface IBRAttributeArgumentParent Represents an interface for BRArguments that can have a child attribute argument.

Enumerations

  Enumeration Description
Public enumeration AttributeDataType Specifies the data types of a member attribute.
Public enumeration AttributeType Specifies the type of an attribute.
Public enumeration AttributeValueType Specifies the value types of a member attribute.
Public enumeration BREntityMemberType Specifies the type of entity member associated with a business rule.
Public enumeration BRItemType Specifies the selected business rule condition or action.
Public enumeration BRPropertyName Specifies the name identifying a property within a business rule component.
Public enumeration BRPropertyType Specifies the business rule property types.
Public enumeration BRStatus Specifies the update and publication status of a business rule.
Public enumeration BusinessRuleType Contains values that specify the business rule type.
Public enumeration DisplayType Contains values specifying the chosen display format for domain-based attribute columns [Code, Code {Name}, Name {Code}].
Public enumeration DomainType Infrastructure. Enumerates the possible types of a domain.
Public enumeration EmailFormat Specifies the email format types.
Public enumeration EntityStagingBatchSelectionMode Specifies an entity staging batch selection mode.
Public enumeration EntityStagingImportType Infrastructure. Specifies the entity staging import type.
Public enumeration ExportViewFormat Specifies the types of export view format.
Public enumeration FunctionalArea Specifies the types of functional area.
Public enumeration GroupType Specifies the type (source) of a security group.
Public enumeration HierarchyItemType Specifies the type of item in a derived hierarchy level.
Public enumeration HierarchyType Specifies the type of hierarchy.
Public enumeration LogicalOperator Specifies the supported logical operators used to join multiple business rule conditions.
Public enumeration MemberKeyLookupType Enumerates the types of key supplied in a member lookup.
Public enumeration MemberReturnOption Specifies one of Data, Counts, or DataAndCounts. The operation response will include member data only, member counts only or both the data and the counts as specified.
Public enumeration MemberType Specifies the type of member for an entity and its associated objects.
Public enumeration ModelObjectType Specifies the model permission types.
Public enumeration ObjectType Specifies the type of master data management (MDM) object.
Public enumeration OperationStatus Infrastructure. Contains values specifying the status of an operation.
Public enumeration Permission Specifies the permission that is assigned to a principal for accessing an Master Data Services function, object or data member.
Public enumeration PermissionType Specifies the permission type of a master data management (MDM) object.
Public enumeration PrincipalType Specifies the various master data management (MDM) type of security principal.
Public enumeration RelationshipType Specifies the type of hierarchy relationship between members.
Public enumeration ResultType Specifies the type of results to return during API get operations.
Public enumeration SearchOption Specifies the search options to use during API get operations.
Public enumeration SecurityPermission Contains values specifying the effective security permission for a user of an MDS object.
Public enumeration SecurityResolutionType Specifies the resolution specification when returning security permissions. Permissions may be retrieved as they were assigned or in a net effective list of permissions.
Public enumeration SortDirection Specifies the sort direction of a sorted column.
Public enumeration StagingBatchDeleteType Contains values specifying the type of deletion to process on staging batches.
Public enumeration StagingBatchStatus Contains values specifying the processing status of a staging (import) batch.
Public enumeration StagingDataStatus Contains values specifying a status indicating the success or failure of staging records.
Public enumeration StagingDataType Contains values specifying the staging data type.
Public enumeration SystemPropertyType Specifies the possible SystemPropertyValue property types.
Public enumeration TransactionType Specifies the type of member change identified in a transaction.
Public enumeration ValidationIssueStatus Contains values specifying the validation issue status.
Public enumeration ValidationStatus Contains values specifying the validation status of a master data member.
Public enumeration VersionStatus Specifies the status of a version.
Public enumeration VersionValidationStatus Specifies the validation status of a version.