Share via

  • Article

Microsoft.MasterDataServices.Services.DataContracts Namespace

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 Represents a custom-defined group of attributes to provide organization to large numbers of entity attributes.
Public class AuditInfo Represents a common complex type used to store object modification history. This type is always used for read-only data.
Public class BRAction Represents an action argument within a created business rule.
Public class BRActionComponent Represents action components of business rules.
Public class BRActionGroup Represents a grouping of related business rule 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 complex type for business rule attribute arguments. This class is abstract.
Public class BRAttributeTypeInfo Represents 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 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 similar available conditions for creation of business rules.
Public class BRConditionTreeNode Represents a logical operator group for conditions.
Public class BRDeleteCriteria Specifies lists of globally unique identifiers (GUIDs) for business rules items to be deleted.
Public class BRDomainBasedAttributeArgument Represents an attribute argument that has a child attribute argument.
Public class BRFreeformArgument Represents a business rule freeform argument.
Public class BRGetCriteria Specifies globally unique identifiers (GUIDs) or names of the desired model, entity, or member type.
Public class BRHierarchyArgument Represents a hierarchy argument that must have a child attribute argument.
Public class BRItem Base class for actions and conditions.
Public class BRItemTypeComponent Base level component 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 container object.
Public class BusinessRuleSet Represents a BusinessRules complex type.
Public class BusinessRulesPalette Represents a collection of all possible actions and conditions used for building business rules within the MDS system.
Public class Collection Retrieves a collection of data contracts.
Public class DerivedHierarchy Represents a synthesized parent-child hierarchy from cascading pre-existing data relationships.
Public class DerivedHierarchyContextIdentifier Represents a set of ID’s for a master data model object that exists in the context of a derived hierarchy.
Public class DerivedHierarchyLevel Extends MdmDataContractOfDerivedHierarchyContextIdentifier complex type.
Public class Entity Represents a container for members and their attribute values and explicit hierarchies.
Public class EntityContextIdentifier Represents a set of identifiers for a master data model object that exists in the context of an entity.
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 EntityMembersGetCriteria Represents a request complex type that defines the EntityMember criteria for the operations result set.
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 Error Represents a data contracts error message.
Public class ErrorContext Represents the context of errors.
Public class ExplicitHierarchy Represents a parent–child relationship that requires all leaf members to be expressed once and only once.
Public class ExportView Represents information related to the user-created view within the MDS system. These views are created to provide simplified SQL access to the data stored in the MDS system in a number of common formats.
Public class FileAttribute Represents some attributes of files.
Public class FunctionPrivilege Represents a function privilege security assignment for a user or group.
Public class FunctionPrivilegesCriteria Specifies function privilege criteria.
Public class Group Represents group complex types.
Public class HierarchyMemberPrivilege Represents a hierarchy member privilege security assignment for a user or group.
Public class HierarchyMemberPrivilegesCriteria Represents a complex type that specifies criteria for hierarchy member privileges.
Public class HierarchyMembers Represents objects used by HierarchyMembersGet.
Public class HierarchyMembersGetCriteria Represents criteria that are used by HierarchyMembersGet.
Public class Identifier Represents a set of ID’s for a master data model object including a globally unique ID (GUID) and unique name within context.
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 MdmDataContract<IdType> Defines the base data contract.
Public class Member Represents a master data member or row of data.
Public class MemberIdentifier Represents a set of IDs for a master data member including the code, name, and type of the member.
Public class MemberKey Represents a complex type that holds either member code or internal ID or both for a member.
Public class MemberSourceTarget Represents a MemberSourceTarget complex type containing members to be copied.
Public class MemberTypeContextIdentifier Represents a set of Identifiers for a master data model object that exists in the context of an entity and member type.
Public class Metadata Represents objects in the MDS system, such as Model, Entity, and so on.
Public class MetadataAttribute Defines the data contract for the Metadata attribute.
Public class MetadataResultOptions Defines the data contract for MetadataResultOptions.
Public class MetadataSearchCriteria Represents 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 Represents the highest level of data organization. Contains all of the members, entities, attributes, hierarchy relationships, collections, business rules, and versions that describe an aspect of the business.
Public class ModelContextIdentifier Represents a set of IDs for a master data model object that exists in the context of a model. This type includes identifiers for the context of the object: the parent model. Examples of objects that have a model context are entities, versions, version flags and derived hierarchies.
Public class ModelMembersGetCriteria Represents members used by used by ModelMembersGet.
Public class ModelMembersResultCriteria Represents criteria for model member results.
Public class ModelPrivilege Represents object-level privilege to the MDS.
Public class ModelPrivilegesCriteria Represents a complex type that specifies criteria for model privileges.
Public class OperationResult Represents a standard container for all operation responses that includes a list of errors.
Public class Parent Represents a member that is a parent (or sometimes a prior sibling) of another master data member within an explicit hierarchy.
Public class ParentChild Represents a parent-child relationship record from a hierarchy.
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 result criteria.
Public class SecurityPrincipals Represents a set of users and user groups.
Public class SecurityPrincipalsCriteria Defines the data contract for the security result criteria.
Public class SecurityPrincipalsDeleteCriteria Represents criteria for deleting security principals.
Public class SecurityPrivileges Represents a set of security privilege assignments at the function, model object and member levels.
Public class SecurityPrivilegesDeleteCriteria Represents a complex type that specifies criteria for deleting security privileges.
Public class SecurityPrivilegesGetCriteria Represents criteria for specifying the types of security privileges to return.
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 StagingBatch Represents a container for a staging batch including the batch identification, errors, stats and members.
Public class StagingBatchError Represents errors in the staging batch process.
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 criteria for the staging result.
Public class StagingSearchCriteria Represents a request complex type that defines the criteria for staging batch types.
Public class StagingUnbatchedCriteria Represents criteria used to identify records to be placed into a new batch.
Public class StagingUnbatchedInformation Represents records in the tblStgMember, tblStgMemberAttribute and tblStgRelationship tables not already in a specific batch.
Public class SystemDomainList Defines the data contract for a system domain list.
Public class SystemDomainListGetCriteria Represents
Public class SystemDomainListItem Defines the data contract for a system domain list item.
Public class SystemPropertyValue Represents a SystemPropertyValue complex type.
Public class SystemSetting Contains values specifying a single setting within the MDM system. These settings should be members of a SystemSettingGroup.
Public class SystemSettingGroup Represents a SystemSettingGroup complex type.
Public class SystemSettingsGetCriteria Identifies a system settings group for retrieval.
Public class Transaction Represents any master data changes along with user and time information associated with the change.
Public class TransactionSearchCriteria Represents a request complex type that defines the Transaction criteria for the operations result set.
Public class User Represents Active Directory users added in MDS.
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 criteria for the validation process.
Public class ValidationProcessOptions Represents a complex type to specify validation process options, namely: (a) whether to commit the version after validation and (b) whether to return back the validation results.
Public class ValidationProcessResult Represents the result of a validation process.
Public class ValidationSearchCriteria Represents the criteria for a validation search.
Public class ValidationSummaryItem Represents a validation summary item.
Public class Version Defines the data contract for the version. Member data is associated with a version.
Public class VersionFlag Represents a custom label for MDS version to aid in integration automation.

Interfaces

  Interface Description
Public interface IBRArgument Represents the interface for all business rule arguments.
Public interface IBRAttributeArgumentContainer Represents an container for business rule argument attributes.
Public interface IBRAttributeArgumentParent Represents the interface for BRArguments that can have a child attribute argument.
Public interface IDataContract Represents an interface that all Metadata data contracts must implement.

Enumerations

  Enumeration Description
Public enumeration AttributeDataType Contains values specifying the data type of attributes.
Public enumeration AttributeType Contains values specifying the type of an attribute.
Public enumeration AttributeValueType Contains values that specify the data type of an attribute.
Public enumeration BREntityMemberType Contains values that specify the type of entity member associated with a business rule.
Public enumeration BRItemType The selected business rule condition or action.
Public enumeration BRPropertyName Contains values used with the name identifying a property within a business rule component.
Public enumeration BRPropertyType Contains values specifying business rule property types.
Public enumeration BRStatus Contains values used for 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 EmailFormat Contains values specifying the preferred email delivery format associated with a user.
Public enumeration ErrorType Contains values specifying the type of data contract error message.
Public enumeration ExportViewFormat Contains values specifying the type of export view format. Export views are available in a known set of standard formats.
Public enumeration FunctionalArea Creates values relevant to the MDS application functional area. Functional areas are used for assigning functional security authorizations.
Public enumeration GroupType Contains values that specify the type (source) of a security group.
Public enumeration HierarchyItemType Represents 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 Contains values specifying logical operators used to join multiple business rule conditions.
Public enumeration MemberKeyLookupType Specifies the type of key supplied in a member lookup: the member code or internal integer ID.
Public enumeration MemberReturnOption Specify 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 MemberStatus Contains values specifying member status.
Public enumeration MemberType Represents the type of member record within an entity.
Public enumeration ModelObjectType Contains values specifying the model permission types.
Public enumeration ObjectType Represents the type of master data 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 specifying the effective permission assigned to a principal for accessing an MDS object.
Public enumeration Preference Contains values specifying user preference settings.
Public enumeration PrincipalType Contains values specifying the type of security principal (user or group).
Public enumeration RelationshipType Contains values specifying the type of hierarchy relationship between members.
Public enumeration ResultType Contains values specifying the level of detail to return for model object queries. The result type is used in association with a particular Object Type.
Public enumeration SearchOption Contains values specifying the scope of metadata objects to be searched. SearchOption allows the exclusion or inclusion of user-created and system objects.
Public enumeration SecurityPermission Contains values specifying the effective security permission for a user of an MDS object.
Public enumeration SecurityResolutionType Contains values specifying 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 Contains values specifying 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 StagingTargetType Contains values specifying the staging target type.
Public enumeration State Contains values specifying the edit state of an MDM object.
Public enumeration SystemPropertyType Contains values specifying the identifying name of one of the available system properties.
Public enumeration TransactionType Contains values specifying 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 Contains values specifying the status of a version.
Public enumeration VersionValidationStatus Contains values specifying the validation status of a version.