MS SSMDSWS
MS SSMDSWS
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
Patents. Microsoft has patents that may cover your implementations of the technologies
described in the Open Specifications. Neither this notice nor Microsoft's delivery of the
documentation grants any licenses under those or any other Microsoft patents. However, a given
Open Specification may be covered by Microsoft Open Specification Promise or the Community
Promise. If you would prefer a written license, or if the technologies described in the Open
Specifications are not covered by the Open Specifications Promise or Community Promise, as
applicable, patent licenses are available by contacting [email protected].
Trademarks. The names of companies and products contained in this documentation may be
covered by trademarks or similar intellectual property rights. This notice does not grant any
licenses under those rights.
Fictitious Names. The example companies, organizations, products, domain names, e-mail
addresses, logos, people, places, and events depicted in this documentation are fictitious. No
association with any real company, organization, product, domain name, email address, logo,
person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights
other than specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications do not require the use of Microsoft programming tools or
programming environments in order for you to develop an implementation. If you have access to
Microsoft programming tools and environments you are free to take advantage of them. Certain
Open Specifications are intended for use in conjunction with publicly available standard
specifications and network programming art, and assumes that the reader either is familiar with the
aforementioned material or has immediate access to it.
1 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Revision Revision
Date History Class Comments
2 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2 Messages................................................................................................................ 21
2.1 Transport............................................................................................................ 21
2.2 Common Message Syntax ..................................................................................... 21
2.2.1 Namespaces .................................................................................................. 21
2.2.2 Messages ...................................................................................................... 21
2.2.2.1 MessageResponse ..................................................................................... 21
2.2.2.2 SecurityPrincipalsRequest .......................................................................... 22
2.2.3 Elements ....................................................................................................... 22
2.2.4 Complex Types .............................................................................................. 22
2.2.4.1 Annotation ............................................................................................... 27
2.2.4.2 ArrayOfAnnotation .................................................................................... 28
2.2.4.3 ArrayOfAttribute ....................................................................................... 28
2.2.4.4 ArrayOfAttributeDataType .......................................................................... 28
2.2.4.5 ArrayOfAttributeGroup .............................................................................. 29
2.2.4.6 ArrayOfBRAction ....................................................................................... 29
2.2.4.7 ArrayOfBRActionComponent ....................................................................... 29
2.2.4.8 ArrayOfBRActionGroup .............................................................................. 30
2.2.4.9 ArrayOfBRAttributeTypeInfo ....................................................................... 30
2.2.4.10 ArrayOfBRCondition ................................................................................ 30
2.2.4.11 ArrayOfBRConditionComponent ................................................................ 31
2.2.4.12 ArrayOfBRConditionGroup ........................................................................ 31
2.2.4.13 ArrayOfBRConditionTreeNode ................................................................... 31
2.2.4.14 ArrayOfBRFreeformArgument ................................................................... 32
2.2.4.15 ArrayOfBusinessRule ............................................................................... 32
2.2.4.16 ArrayOfDerivedHierarchy ......................................................................... 32
2.2.4.17 ArrayOfDerivedHierarchyLevel .................................................................. 32
2.2.4.18 ArrayOfEntity ......................................................................................... 33
2.2.4.19 ArrayOfEntityMembers ............................................................................. 33
2.2.4.20 ArrayOfEntityMemberType ....................................................................... 33
2.2.4.21 ArrayOfExplicitHierarchy .......................................................................... 34
2.2.4.22 ArrayOfExportView .................................................................................. 34
2.2.4.23 ArrayOfFunctionPrivilege .......................................................................... 34
2.2.4.24 ArrayOfGroup ......................................................................................... 35
2.2.4.25 ArrayOfHierarchyMemberPrivilege ............................................................. 35
2.2.4.26 ArrayOfIdentifier ..................................................................................... 35
2.2.4.27 ArrayOfCollection .................................................................................... 36
2.2.4.28 ArrayOfMDMError .................................................................................... 36
3 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
4 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
5 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
6 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
7 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
8 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
9 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
10 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
11 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
12 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
13 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
14 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
15 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
1.1 Glossary
action: A business rule argument that determines what occurs when the business rule is run at
validation time.
business rule: A user-defined process that can proactively manage data within the Master Data
Services database.
child: A data item within the Master Data Services system that has a superior data item. A child
in Master Data Services can be a leaf member or a consolidated member.
condition: A business rule argument that determines when to apply the actions of the
business rule. Conditions can be parsed together by using the logical operators AND and OR.
consolidated member: A container member within the Master Data Services system.
Consolidated members can be superior to leaf members or to other consolidated members.
entity: Tabular data that is stored within the Master Data Services system.
hierarchy: An arrangement of data items within the Master Data Services system in a ranked or
graduated series.
leaf member: A standard member of any entity within the Master Data Services system.
master data: The nouns of the business, master data are non-transactional data sets that
provide context to the organization.
member: A single master data record that is stored in the Master Data Services system.
model: The highest level of data organization in Master Data Services. A model contains the
following model objects:
Entities
16 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
A model contains entities. Entities contain attributes, explicit hierarchies, and collections.
Attributes can be contained in attribute groups. Domain-based attributes (DBAs) exist when
an entity is used as an attribute for another entity.
parent: A data item within the Master Data Services system that can contain child members.
publish: An operation that makes business rules available for use within the Master Data
Services system.
version: A snapshot of data members within a model that may correspond to a specific period
of time.
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as
described in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or
SHOULD NOT.
1.2 References
References to Microsoft Open Specification documents do not include a publishing year because links
are to the latest version of the documents, which are updated frequently. References to other
documents include a publishing year when one is available.
We conduct frequent surveys of the normative references to assure their continued availability. If
you have any issue with finding a normative reference, please contact [email protected]. We
will assist you in finding the relevant information. Please check the archive site,
http://msdn2.microsoft.com/en-us/library/E4BD6494-06AD-4aed-9823-445E921C9624, as an
additional source.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC
2119, March 1997, http://www.ietf.org/rfc/rfc2119.txt
[SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., Layman, A., Mendelsohn, N., Nielsen, H. F.,
Thatte, S., and Winer, D., "Simple Object Access Protocol (SOAP) 1.1", May 2000,
http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description
Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315
[WSDLSOAP] Angelov, D., Ballinger, K., Butek, R., et al., "WSDL 1.1 Binding Extension for SOAP
1.2", W3c Member Submission, April 2006, http://www.w3.org/Submission/wsdl11soap12/
[XMLNS3] World Wide Web Consortium, "Namespaces in XML 1.0 (Third Edition)", December 2009,
http://www.w3.org/TR/2009/REC-xml-names-20091208/
[XMLSCHEMA1] Thompson, H.S., Ed., Beech, D., Ed., Maloney, M., Ed., and Mendelsohn, N., Ed.,
"XML Schema Part 1: Structures", W3C Recommendation, May 2001,
http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/
[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C
Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/
17 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The SQL Server Master Data Services service and API provide two main functions:
Adoption of a service-oriented design architecture (SOA) that encapsulates and modularizes the
internal workings of the product
Creation of a standard API to interact and integrate with SQL Server Master Data Services
The SQL Server Master Data Services framework ensures that the internal functions of the product
are better modularized to support both an API and a modular component development.
In this document, the term "services" includes but is not necessarily limited to Web services.
"Services" means a modular architecture based on the Windows Communication Foundation (WCF).
SQL Server Master Data Services Web Services uses SOAP over HTTP as shown in the following
layering diagram.
SQL Server Master Data Services Web Services uses SOAP over HTTPS as shown in the following
layering diagram.
18 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
1.5 Prerequisites/Preconditions
None.
The SQL Server Master Data Services Web Service Specification should be used in all instances
when automating interactions with the Master Data Services (MDS) system. This protocol
encapsulates all the MDS functionality that is exposed to the user.
This document covers versioning issues for the SQL Server Master Data Services Web Service
Specification in the following areas:
Supported Transports: This protocol uses multiple transports with SOAP as specified in section
2.1.
Protocol Versions: This protocol has a separate Web Services Description Language
(WSDL) port type for each version. These versions are defined in section 3.1.
Protocol Versions: This protocol has only one WSDL port type version, but that WSDL port
type has been extended by adding new operations. The use of these operations is specified in
section 3.1.
Protocol Versions: This protocol has only one WSDL port type version with a single set of
operations, but the format of the messages used in the operations has been extended. The use of
these operations is specified in section 3.1.
Security and Authentication Methods: This protocol supports the following authentication
methods: LANMAN, NTLM, and Kerberos. These authentication methods are defined in section
3.1.4.
Localization: This protocol includes text strings in various messages. Localization considerations
for such strings are specified in sections 2.2 and 3.1.4.
Capability Negotiation: The Ethernet protocol does not support negotiation of the interface
version to use. There are no additional versions of API to negotiate at this time.
19 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
None.
None.
20 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.1 Transport
The SOAP 1.1 Web service message protocol (as specified in [SOAP1.1]) and SOAP 1.2 (as specified
in [WSDLSOAP]) are supported.
This section contains common definitions that are used by this protocol. The syntax of the definitions
uses XML schema as defined in [XMLSCHEMA1] and [XMLSCHEMA2], and it uses Web Services
Description Language (WSDL) as defined in [WSDL].
2.2.1 Namespaces
This specification defines and references various XML namespaces by using the mechanisms that
are specified in [XMLNS3]. Although this specification associates a specific XML namespace prefix for
each XML namespace that is used, the choice of any particular XML namespace prefix is
implementation-specific and not significant for interoperability.
mds urn:schemas-microsoft-com:xml-mds
2.2.2 Messages
Message Description
SecurityPrincipalsRequest The parameters that are used to filter the list that is returned from a
principals request.
2.2.2.1 MessageResponse
The MessageResponse is a standard message that is returned when the provided information is
updated successfully within MDS.
<wsdl:message name="MessageResponse">
21 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.2.2 SecurityPrincipalsRequest
The SecurityPrincipalsRequest message is a list of parameters used to filter the list of returned
SecurityPrincipals.
<wsdl:message name="SecurityPrincipalsRequest">
<wsdl:part name="parameters" element="tns:SecurityPrincipalsRequest"/>
</wsdl:message>
2.2.3 Elements
<xs:element name="SecurityPrincipalsRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q95="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Principals" nillable="true" type="q95:SecurityPrincipals" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following table summarizes the set of common XML schema complex type definitions that are
defined by this specification. XML schema complex type definitions that are specific to a particular
operation are described with the operation.
22 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
23 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
types.
24 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
25 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
26 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.1 Annotation
The following is the XSD schema definition of the Annotation complex type.
27 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.2 ArrayOfAnnotation
The following is the XSD schema definition of the ArrayOfAnnotation complex type.
<xs:complexType name="ArrayOfAnnotation">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Annotation" nillable="true"
type="tns:Annotation" />
</xs:sequence>
</xs:complexType>
2.2.4.3 ArrayOfAttribute
The following is the XSD schema definition of the ArrayOfAttribute complex type.
<xs:complexType name="ArrayOfAttribute">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Attribute" nillable="true"
type="tns:Attribute" />
</xs:sequence>
</xs:complexType>
2.2.4.4 ArrayOfAttributeDataType
The following is the XSD schema definition of the ArrayOfAttributeDataType complex type.
28 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.5 ArrayOfAttributeGroup
The following is the XSD schema definition of the ArrayOfAttributeGroup complex type.
<xs:complexType name="ArrayOfAttributeGroup">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="AttributeGroup" nillable="true"
type="tns:AttributeGroup" />
</xs:sequence>
</xs:complexType>
2.2.4.6 ArrayOfBRAction
The following is the XSD schema definition of the ArrayOfBRAction complex type.
<xs:complexType name="ArrayOfBRAction">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRAction" nillable="true"
type="tns:BRAction" />
</xs:sequence>
</xs:complexType>
2.2.4.7 ArrayOfBRActionComponent
The following is the XSD schema definition of the ArrayOfBRActionComponent complex type.
<xs:complexType name="ArrayOfBRActionComponent">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRActionComponent"
nillable="true" type="tns:BRActionComponent" />
29 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.8 ArrayOfBRActionGroup
The following is the XSD schema definition of the ArrayOfBRActionGroup complex type.
<xs:complexType name="ArrayOfBRActionGroup">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRActionGroup" nillable="true"
type="tns:BRActionGroup" />
</xs:sequence>
</xs:complexType>
2.2.4.9 ArrayOfBRAttributeTypeInfo
The following is the XSD schema definition of the ArrayOfBRAttributeTypeInfo complex type.
<xs:complexType name="ArrayOfBRAttributeTypeInfo">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRAttributeTypeInfo"
nillable="true" type="tns:BRAttributeTypeInfo" />
</xs:sequence>
</xs:complexType>
2.2.4.10 ArrayOfBRCondition
The following is the XSD schema definition of the ArrayOfBRCondition complex type.
<xs:complexType name="ArrayOfBRCondition">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRCondition" nillable="true"
type="tns:BRCondition" />
</xs:sequence>
</xs:complexType>
30 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following is the XSD schema definition of the ArrayOfBRConditionComponent complex type.
<xs:complexType name="ArrayOfBRConditionComponent">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRConditionComponent"
nillable="true" type="tns:BRConditionComponent" />
</xs:sequence>
</xs:complexType>
2.2.4.12 ArrayOfBRConditionGroup
The following is the XSD schema definition of the ArrayOfBRConditionGroup complex type.
<xs:complexType name="ArrayOfBRConditionGroup">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRConditionGroup" nillable="true"
type="tns:BRConditionGroup" />
</xs:sequence>
</xs:complexType>
2.2.4.13 ArrayOfBRConditionTreeNode
The following is the XSD schema definition of the ArrayOfBRConditionTreeNode complex type.
<xs:complexType name="ArrayOfBRConditionTreeNode">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRConditionTreeNode"
nillable="true" type="tns:BRConditionTreeNode" />
</xs:sequence>
</xs:complexType>
31 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following is the XSD schema definition of the ArrayOfBRFreeformArgument complex type.
<xs:complexType name="ArrayOfBRFreeformArgument">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BRFreeformArgument"
nillable="true" type="tns:BRFreeformArgument" />
</xs:sequence>
</xs:complexType>
2.2.4.15 ArrayOfBusinessRule
The following is the XSD schema definition of the ArrayOfBusinessRule complex type.
<xs:complexType name="ArrayOfBusinessRule">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="BusinessRule" nillable="true"
type="tns:BusinessRule" />
</xs:sequence>
</xs:complexType>
2.2.4.16 ArrayOfDerivedHierarchy
The following is the XSD schema definition of the ArrayOfDerivedHierarchy complex type.
<xs:complexType name="ArrayOfDerivedHierarchy">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DerivedHierarchy" nillable="true"
type="tns:DerivedHierarchy" />
</xs:sequence>
</xs:complexType>
2.2.4.17 ArrayOfDerivedHierarchyLevel
32 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:complexType name="ArrayOfDerivedHierarchyLevel">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="DerivedHierarchyLevel"
nillable="true" type="tns:DerivedHierarchyLevel" />
</xs:sequence>
</xs:complexType>
2.2.4.18 ArrayOfEntity
The following is the XSD schema definition of the ArrayOfEntity complex type.
<xs:complexType name="ArrayOfEntity">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Entity" nillable="true"
type="tns:Entity" />
</xs:sequence>
</xs:complexType>
2.2.4.19 ArrayOfEntityMembers
The following is the XSD schema definition of the ArrayOfEntityMembers complex type.
<xs:complexType name="ArrayOfEntityMembers">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="EntityMembers" nillable="true"
type="tns:EntityMembers" />
</xs:sequence>
</xs:complexType>
2.2.4.20 ArrayOfEntityMemberType
The following is the XSD schema definition of the ArrayOfEntityMemberType complex type.
<xs:complexType name="ArrayOfEntityMemberType">
<xs:sequence>
33 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.21 ArrayOfExplicitHierarchy
The following is the XSD schema definition of the ArrayOfExplicitHierarchy complex type.
<xs:complexType name="ArrayOfExplicitHierarchy">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ExplicitHierarchy"
nillable="true" type="tns:ExplicitHierarchy" />
</xs:sequence>
</xs:complexType>
2.2.4.22 ArrayOfExportView
The following is the XSD schema definition of the ArrayOfExportView complex type.
<xs:complexType name="ArrayOfExportView">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ExportView" nillable="true"
type="tns:ExportView" />
</xs:sequence>
</xs:complexType>
2.2.4.23 ArrayOfFunctionPrivilege
The following is the XSD schema definition of the ArrayOfFunctionPrivilege complex type.
<xs:complexType name="ArrayOfFunctionPrivilege">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="FunctionPrivilege"
nillable="true" type="tns:FunctionPrivilege" />
</xs:sequence>
34 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.24 ArrayOfGroup
The following is the XSD schema definition of the ArrayOfGroup complex type.
<xs:complexType name="ArrayOfGroup">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Group" nillable="true"
type="tns:Group" />
</xs:sequence>
</xs:complexType>
2.2.4.25 ArrayOfHierarchyMemberPrivilege
<xs:complexType name="ArrayOfHierarchyMemberPrivilege">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="HierarchyMemberPrivilege"
nillable="true" type="tns:HierarchyMemberPrivilege" />
</xs:sequence>
</xs:complexType>
2.2.4.26 ArrayOfIdentifier
The following is the XSD schema definition of the ArrayOfIdentifier complex type.
<xs:complexType name="ArrayOfIdentifier">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Identifier" nillable="true"
type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
35 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following is the XSD schema definition of the ArrayOfCollection complex type.
<xs:complexType name="ArrayOfCollection">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Collection" nillable="true"
type="tns: Collection" />
</xs:sequence>
</xs:complexType>
2.2.4.28 ArrayOfMDMError
The following is the XSD schema definition of the ArrayOfMDMError complex type.
<xs:complexType name="ArrayOfMDMError">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="MDMError" nillable="true"
type="tns:MDMError" />
</xs:sequence>
</xs:complexType>
2.2.4.29 ArrayOfMember
The following is the XSD schema definition of the ArrayOfMember complex type.
<xs:complexType name="ArrayOfMember">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Member" nillable="true"
type="tns:Member" />
</xs:sequence>
</xs:complexType>
2.2.4.30 ArrayOfMemberIdentifier
The following is the XSD schema definition of the ArrayOfMemberIdentifier complex type.
36 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.31 ArrayOfMemberType
The following is the XSD schema definition of the ArrayOfMemberType complex type.
<xs:complexType name="ArrayOfMemberType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="MemberType" type="tns:MemberType"
/>
</xs:sequence>
</xs:complexType>
2.2.4.32 ArrayOfMetaDataAttribute
The following is the XSD schema definition of the ArrayOfMetadataAttribute complex type.
<xs:complexType name="ArrayOfMetadataAttribute">
<xs:sequence>
<xs:element
xmlns:q199="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09" minOccurs="0"
maxOccurs="unbounded" name="MetadataAttribute" nillable="true" type="q199:MetadataAttribute"
/>
</xs:sequence>
</xs:complexType>
2.2.4.33 ArrayOfModel
The following is the XSD schema definition of the ArrayOfModel complex type.
<xs:complexType name="ArrayOfModel">
<xs:sequence>
37 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.34 ArrayOfModelPrivilege
The following is the XSD schema definition of the ArrayOfModelPrivilege complex type.
<xs:complexType name="ArrayOfModelPrivilege">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ModelPrivilege" nillable="true"
type="tns:ModelPrivilege" />
</xs:sequence>
</xs:complexType>
2.2.4.35 ArrayOfParent
The following is the XSD schema definition of the ArrayOfParent complex type.
<xs:complexType name="ArrayOfParent">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Parent" nillable="true"
type="tns:Parent" />
</xs:sequence>
</xs:complexType>
2.2.4.36 ArrayOfParentChild
The following is the XSD schema definition of the ArrayOfParentChild complex type.
<xs:complexType name="ArrayOfParentChild">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ParentChild" nillable="true"
type="tns:ParentChild" />
</xs:sequence>
</xs:complexType>
38 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following is the XSD schema definition of the ArrayOfStagingBatch complex type.
<xs:complexType name="ArrayOfStagingBatch">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="StagingBatch" nillable="true"
type="tns:StagingBatch" />
</xs:sequence>
</xs:complexType>
2.2.4.38 ArrayOfStagingBatchError
The following is the XSD schema definition of the ArrayOfStagingBatchError complex type.
<xs:complexType name="ArrayOfStagingBatchError">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="StagingBatchError"
nillable="true" type="tns:StagingBatchError" />
</xs:sequence>
</xs:complexType>
2.2.4.39 ArrayOfStagingUnbatchedInformation
<xs:complexType name="ArrayOfStagingUnbatchedInformation">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="StagingUnbatchedInformation"
nillable="true" type="tns:StagingUnbatchedInformation" />
</xs:sequence>
</xs:complexType>
2.2.4.40 ArrayOfSystemSetting
39 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:complexType name="ArrayOfSystemSetting">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="SystemSetting" nillable="true"
type="tns:SystemSetting" />
</xs:sequence>
</xs:complexType>
2.2.4.41 ArrayOfSystemSettingGroup
The following is the XSD schema definition of the ArrayOfSystemSettingGroup complex type.
<xs:complexType name="ArrayOfSystemSettingGroup">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="SystemSettingGroup"
nillable="true" type="tns:SystemSettingGroup" />
</xs:sequence>
</xs:complexType>
2.2.4.42 ArrayOfTransaction
The following is the XSD schema definition of the ArrayOfTransaction complex type.
<xs:complexType name="ArrayOfTransaction">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Transaction" nillable="true"
type="tns:Transaction" />
</xs:sequence>
</xs:complexType>
2.2.4.43 ArrayOfUser
The following is the XSD schema definition of the ArrayOfUser complex type.
<xs:complexType name="ArrayOfUser">
<xs:sequence>
40 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.44 ArrayOfValidationIssue
The following is the XSD schema definition of the ArrayOfValidationIssue complex type.
<xs:complexType name="ArrayOfValidationIssue">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ValidationIssue" nillable="true"
type="tns:ValidationIssue" />
</xs:sequence>
</xs:complexType>
2.2.4.45 ArrayOfVersion
The following is the XSD schema definition of the ArrayOfVersion complex type.
<xs:complexType name="ArrayOfVersion">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Version" nillable="true"
type="tns:Version" />
</xs:sequence>
</xs:complexType>
2.2.4.46 ArrayOfVersionFlag
The following is the XSD schema definition of the ArrayOfVersionFlag complex type.
<xs:complexType name="ArrayOfVersionFlag">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="VersionFlag" nillable="true"
type="tns:VersionFlag" />
</xs:sequence>
</xs:complexType>
41 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The Attribute complex type specifies a master data attribute, including its identification and data
value.
The following is the XSD schema definition of the Attribute complex type.
<xs:complexType name="Attribute">
<xs:sequence>
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Type" type="tns:AttributeValueType" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:anyType" />
</xs:sequence>
</xs:complexType>
Type: Specifies the AttributeValueType or the type of value that is stored by the attribute.
Value: Specifies the value that is assigned to the master data attribute as a variant data type.
2.2.4.48 AttributeGroup
The AttributeGroup complex type specifies a custom grouping of attributes that can contain a
subset of the entity attributes and that can set a display order of these attributes. The attributes can
be in multiple attribute groups.
The following is the XSD schema definition of the AttributeGroup complex type.
<xs:complexType name="AttributeGroup">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfMemberTypeContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="Attributes" nillable="true"
type="tns:ArrayOfMetaDataAttribute" />
<xs:element minOccurs="0" name="FullName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="IsNameCodeFrozen" type="xs:boolean" />
<xs:element minOccurs="0" name="IsSystem" type="xs:boolean" />
<xs:element minOccurs="0" name="SortOrder" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
FullName: Specifies a string that specifies the full name of the attribute group.
IsNameCodeFrozen: Specifies a Boolean that specifies whether the Name and Code fields
should be static in the user interface.
IsSystem: Specifies a Boolean that specifies whether the attribute group is created by the MDS
system.
42 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.49 AuditInfo
The AuditInfo complex type specifies a common complex type that is used to store object
modification history. This complex type MUST be used for read-only data.
The following is the XSD schema definition of the AuditInfo complex type.
<xs:complexType name="AuditInfo">
<xs:sequence>
<xs:element minOccurs="0" name="CreatedDateTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="CreatedUserId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="CreatedVersionId" nillable="true" type="tns:Identifier"
/>
<xs:element minOccurs="0" name="UpdatedDateTime" type="xs:dateTime" />
<xs:element minOccurs="0" name="UpdatedUserId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="UpdatedVersionId" nillable="true" type="tns:Identifier"
/>
</xs:sequence>
</xs:complexType>
CreatedDateTime: Specifies the date and time at which the associated object was created.
CreatedUserId: Specifies the Identifier of the user who created the associated object.
CreatedVersionId: Specifies the Identifier of the version in which the associated object was
created.
UpdatedDateTime: Specifies the date and time at which the associated object was last updated.
UpdatedUserId: Specifies the Identifier of the user who last updated the object.
UpdatedVersionId: Specifies the Identifier of the version in which the associated object was last
updated.
2.2.4.50 BRAction
The BRAction complex type specifies a value creation or validation action within a created business
rule.
The following is the XSD schema definition of the BRAction complex type.
<xs:complexType name="BRAction">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRItem">
<xs:sequence>
<xs:element minOccurs="0" name="PrefixArgument" nillable="true"
type="tns:BRAttributeArgument" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
43 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.51 BRActionComponent
The BRActionComponent complex type specifies the action components of business rules.
BRActionComponent extends the BRItemTypeComponent complex type.
The following is the XSD schema definition of the BRActionComponent complex type.
<xs:complexType name="BRActionComponent">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRItemTypeComponent">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.52 BRActionGroup
The BRActionGroup complex type specifies a grouping of related business rule action components
that are currently available for use in MDS.
The following is the XSD schema definition of the BRActionGroup complex type.
<xs:complexType name="BRActionGroup">
<xs:sequence>
<xs:element minOccurs="0" name="BRActionComponents" nillable="true"
type="tns:ArrayOfBRActionComponent" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
2.2.4.53 BRArgument
The BRArgument complex type specifies the base type for all business rule arguments.
The following is the XSD schema definition of the BRArgument complex type.
<xs:complexType name="BRArgument">
<xs:sequence>
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="PropertyName" type="tns:BRPropertyName" />
</xs:sequence>
</xs:complexType>
44 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.54 BRAttributeArgument
The BRAttributeArgument complex type specifies the argument type for comparing attributes
within a business rule. This is the values that are set for each member as opposed to a specific
value against all members. BRAttributeArgument extends the BRAttributeArgumentBase complex
type.
The following is the XSD schema definition of the BRAttributeArgument complex type.
<xs:complexType name="BRAttributeArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRAttributeArgumentBase">
<xs:sequence>
<xs:element minOccurs="0" name="ChildArguments" nillable="true"
type="tns:ArrayOfBRFreeformArgument" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.55 BRAttributeArgumentBase
The BRAttributeArgumentBase complex type specifies a base complex type for business rule
attribute arguments. BRAttributeArgumentBase extends the BRArgument complex type.
The following is the XSD schema definition of the BRAttributeArgumentBase complex type.
<xs:complexType name="BRAttributeArgumentBase">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRArgument">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true" type="tns:Identifier"
/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.56 BRAttributeTypeInfo
The BRAttributeTypeInfo complex type specifies the attribute type information for business rule
attributes.
The following is the XSD schema definition of the BRAttributeTypeInfo complex type.
<xs:complexType name="BRAttributeTypeInfo">
45 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.57 BRAttributeValueArgument
The BRAttributeValueArgument complex type specifies the BRAttribute freeform value set in
conditions and validation actions.
The following is the XSD schema definition of the BRAttributeValueArgument complex type.
<xs:complexType name="BRAttributeValueArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRArgument">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeCode" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.58 BRBlankArgument
The BRBlankArgument complex type is used to create business rules in an evaluation against a
blank argument, and is used where the BRArgument complex type is used.
The following is the XSD schema definition of the BRBlankArgument complex type.
<xs:complexType name="BRBlankArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRArgument">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.59 BRCondition
The BRCondition complex type specifies a container for conditions to be evaluated to trigger
actions that are defined in a created business rule.
The following is the XSD schema definition of the BRCondition complex type.
46 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.60 BRConditionComponent
The following is the XSD schema definition of the BRConditionComponent complex type.
<xs:complexType name="BRConditionComponent">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRItemTypeComponent">
<xs:sequence />
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.61 BRConditionGroup
The BRConditionGroup complex type specifies a group of conditions that have a similar type of
logical evaluator.
The following is the XSD schema definition of the BRConditionGroup complex type.
<xs:complexType name="BRConditionGroup">
<xs:sequence>
<xs:element minOccurs="0" name="BRConditionComponents" nillable="true"
type="tns:ArrayOfBRConditionComponent" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
47 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The BRConditionTreeNode complex type specifies a node within a possible complex logic tree in a
business rule in MDS. A BRConditionTreeNode MUST exist for each business rule condition that is
created.
The following is the XSD schema definition of the BRConditionTreeNode complex type.
<xs:complexType name="BRConditionTreeNode">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="BRConditions" nillable="true"
type="tns:ArrayOfBRCondition" />
<xs:element minOccurs="0" name="BusinessRuleId" nillable="true"
type="tns:MemberTypeContextIdentifier" />
<xs:element minOccurs="0" name="ConditionTreeChildNodes" nillable="true"
type="tns:ArrayOfBRConditionTreeNode" />
<xs:element minOccurs="0" name="ConditionTreeParentNode" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="LogicalOperator" type="tns:LogicalOperator" />
<xs:element minOccurs="0" name="Sequence" type="xs:int" />
</xs:sequence>
</xs:complexType>
Sequence: Specifies an integer value that represents the order in which the tree node should be
displayed and evaluated.
2.2.4.63 BRDomainBasedAttributeArgument
<xs:complexType name="BRDomainBasedAttributeArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRAttributeArgumentBase">
<xs:sequence>
48 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.64 BRFreeformArgument
The BRFreeformArgument complex type specifies the freeform argument type for business rule
arguments. BRFreeformArgument extends the BRArgument complex type.
The following is the XSD schema definition of the BRFreeformArgument complex type.
<xs:complexType name="BRFreeformArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRArgument">
<xs:sequence>
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Value: Specifies a string that represents the business rule freeform argument.
2.2.4.65 BRHierarchyArgument
The BRHierarchyArgument complex type holds the business rule arguments that relate to child
members from an explicit hierarchy. BRHierarchyArgument extends the BRArgument complex
type.
The following is the XSD schema definition of the BRHierarchyArgument complex type.
<xs:complexType name="BRHierarchyArgument">
<xs:complexContent mixed="false">
<xs:extension base="tns:BRArgument">
<xs:sequence>
<xs:element minOccurs="0" name="ChildArgument" nillable="true"
type="tns:BRAttributeArgument" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier"
/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
49 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The BRItem complex type specifies a logical part of a complete business rule.
The following is the XSD schema definition of the BRItem complex type.
<xs:complexType name="BRItem">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="BusinessRuleId" nillable="true"
type="tns:MemberTypeContextIdentifier" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Operator" type="tns:BRItemType" />
<xs:element xmlns:q49="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
minOccurs="0" name="PostfixArguments" nillable="true" type="q49:ArrayOfAnyType" />
<xs:element minOccurs="0" name="Sequence" type="xs:int" />
<xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
Sequence: Specifies an integer value that represents the order in which business rule items should
be displayed and evaluated.
Text:
2.2.4.67 BRItemTypeComponent
The BRItemTypeComponent complex type specifies the base-level components type of business
rules.
The following is the XSD schema definition of the BRItemTypeComponent complex type.
<xs:complexType name="BRItemTypeComponent">
<xs:sequence>
<xs:element minOccurs="0" name="CompatibleAttributeTypes" nillable="true"
type="tns:ArrayOfBRAttributeTypeInfo" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ItemType" type="tns:BRItemType" />
</xs:sequence>
</xs:complexType>
50 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.68 BusinessRule
The following is the XSD schema definition of the BusinessRule complex type.
<xs:complexType name="BusinessRule">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="BRActions" nillable="true" type="tns:ArrayOfBRAction"
/>
<xs:element minOccurs="0" name="BRConditionTree" nillable="true"
type="tns:BRConditionTreeNode" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Identifier" nillable="true"
type="tns:MemberTypeContextIdentifier" />
<xs:element minOccurs="0" name="IsSystemRule" type="xs:boolean" />
<xs:element minOccurs="0" name="RuleActionText" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="RuleConditionText" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Status" type="tns:BRStatus" />
</xs:sequence>
</xs:complexType>
IsSystemRule: A Boolean value that indicates whether the rule has been created by the MDS
system.
RuleActionText: A string representation of business rule actions that are included in the current
business rule.
RuleConditionText: A string representation of business rule conditions that are included in the
current business rule.
2.2.4.69 BusinessRules
The BusinessRules complex type specifies containers for conditions and actions.
The following is the XSD schema definition of the BusinessRules complex type.
<xs:complexType name="BusinessRules">
<xs:sequence>
51 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.70 BusinessRulesPalette
The BusinessRulesPalette complex type is a collection of all possible actions and conditions that
are used for building business rules within the MDS system.
The following is the XSD schema definition of the BusinessRulesPalette complex type.
<xs:complexType name="BusinessRulesPalette">
<xs:sequence>
<xs:element minOccurs="0" name="BRActionGroups" nillable="true"
type="tns:ArrayOfBRActionGroup" />
<xs:element minOccurs="0" name="BRConditionGroups" nillable="true"
type="tns:ArrayOfBRConditionGroup" />
</xs:sequence>
</xs:complexType>
2.2.4.71 DerivedHierarchy
The DerivedHierarchy complex type specifies an already defined data relationship and prepares
that relationship to be displayed in a hierarchical fashion.
The following is the XSD schema definition of the DerivedHierarchy complex type.
<xs:complexType name="DerivedHierarchy">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfModelContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="FullyQualifiedName" nillable="true"
type="xs:string" />
<xs:element minOccurs="0" name="Levels" nillable="true"
type="tns:ArrayOfDerivedHierarchyLevel" />
52 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
FullyQualifiedName: Specifies the string value of the fully qualified name of the entity.
2.2.4.72 DerivedHierarchyContextIdentifier
The DerivedHierarchyContextIdentifier complex type specifies a set of IDs for a master data
model object that exists in the context of a derived hierarchy. This complex type includes identifiers
for the context of the object, including the parent derived hierarchy and model. This complex type is
used by derived hierarchy levels and is an extension of the base type ModelContextIdentifier.
<xs:complexType name="DerivedHierarchyContextIdentifier">
<xs:complexContent mixed="false">
<xs:extension base="tns:ModelContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="DerivedHierarchyId" nillable="true"
type="tns:Identifier" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
DerivedHierarchyId: Specifies the Identifier of the parent derived hierarchy of the object.
2.2.4.73 DerivedHierarchyLevel
The DerivedHierarchyLevel complex type specifies a single level within the derived hierarchy data
relationship tree. DerivedHierarchyLevel extends the
MdmDataContractOfDerivedHierarchyContextIdentifier complex type.
The following is the XSD schema definition of the DerivedHierarchyLevel complex type.
<xs:complexType name="DerivedHierarchyLevel">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfDerivedHierarchyContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="DisplayName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ForeignEntityId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="ForeignId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q41="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="ForeignType" type="q41:HierarchyItemType" />
<xs:element minOccurs="0" name="IsVisible" type="xs:boolean" />
<xs:element minOccurs="0" name="LevelNumber" type="xs:int" />
53 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.74 Entity
The Entity complex type specifies a container for members and their attribute values and explicit
hierarchy. Entity extends the MdmDataContractOfModelContextIdentifier complex type.
The following is the XSD schema definition of the Entity complex type.
<xs:complexType name="Entity">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfModelContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="ExplicitHierarchies" nillable="true"
type="tns:ArrayOfExplicitHierarchy" />
<xs:element minOccurs="0" name="IsBase" type="xs:boolean" />
<xs:element minOccurs="0" name="IsFlat" type="xs:boolean" />
<xs:element minOccurs="0" name="IsSystem" type="xs:boolean" />
<xs:element minOccurs="0" name="MemberTypes" nillable="true"
type="tns:ArrayOfEntityMemberType" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
IsBase: Specifies a flag that determines whether an entity shows on a model explorer initial screen
as a main entity.
IsFlat: Specifies a flag that determines whether an entity supports explicit hierarchies.
IsSystem: Specifies a flag that indicates whether an entity was created by the MDS system.
System entities cannot be deleted.
54 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The EntityContextIdentifier complex type specifies a set of IDs for a master data model object
that exists in the context of an entity. This type includes identifiers for the context of the object,
including parent entity and model. An example of an object that has an entity context is an explicit
hierarchy.
The following is the XSD schema definition of the EntityContextIdentifier complex type.
<xs:complexType name="EntityContextIdentifier">
<xs:complexContent mixed="false">
<xs:extension base="tns:ModelContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.76 EntityMembers
The EntityMembers complex type contains a collection of members from a single entity and
member type along with their context.
The following is the XSD schema definition of the EntityMembers complex type.
<xs:complexType name="EntityMembers">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="MemberType" nillable="true" type="tns:MemberType" />
<xs:element minOccurs="0" name="Members" nillable="true" type="tns:ArrayOfMember" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
EntityId: Specifies the Identifier of the entity for the contained members.
Members: Specifies an ArrayOfMember that contains a list of members for the identified entity and
member type.
ModelId: Specifies the Identifier of the model for the contained members.
VersionId: Specifies the Identifier of the version for the contained members.
55 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The EntityMemberType complex type specifies the structure of an entity within MDS, including
attributes and attribute groups. EntityMemberType extends the MdmDataContractOfIdentifier
complex type.
The following is the XSD schema definition for the EntityMemberType complex type.
<xs:complexType name="EntityMemberType">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeGroups" nillable="true"
type="tns:ArrayOfAttributeGroup" />
<xs:element minOccurs="0" name="Attributes" nillable="true"
type="tns:ArrayOfMetaDataAttribute" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Type" type="tns:MemberType" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.78 ExplicitHierarchy
The ExplicitHierarchy complex type specifies a parent–child representation that requires that all
leaf members be expressed exactly one time.
The following is the XSD schema definition of the ExplicitHierarchy complex type.
<xs:complexType name="ExplicitHierarchy">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfEntityContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="FullyQualifiedName" nillable="true"
type="xs:string" />
<xs:element minOccurs="0" name="IsMandatory" type="xs:boolean" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
56 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.79 ExportView
The ExportView complex type specifies information that is related to a user-created view within the
MDS system. These views are created to provide simplified SQL access to the data that is stored in
the MDS system in a number of common formats.
The following is the XSD schema definition of the ExportView complex type.
<xs:complexType name="ExportView">
<xs:sequence>
<xs:element minOccurs="0" name="DerivedHierarchyId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="IsDirty" type="xs:boolean" />
<xs:element minOccurs="0" name="Levels" type="xs:int" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionFlagId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ViewFormat" type="tns:ExportViewFormat" />
</xs:sequence>
</xs:complexType>
DerivedHierarchyId: Specifies the Identifier of the derived hierarchy that is queried by the export
view. This value is populated only for view formats that are specific to derived hierarchies.
EntityId: Specifies the Identifier of the entity that is queried by the export view.
IsDirty: Specifies a Boolean that is set to true if the view needs to be re-created due to underlying
metadata changes.
Levels: Specifies the number of hierarchy levels in the view if the view is a level-based hierarchy
view.
ModelId: Specifies the Identifier of the model that is queried by the export view.
VersionFlagId: Specifies the Identifier of the version flag that is queried by the export view.
VersionId: Specifies the Identifier of the version that is queried by the export view.
2.2.4.80 FunctionPrivilege
The FunctionPrivilege complex type specifies a function privilege security assignment for a user or
group.
The following is the XSD schema definition of the FunctionPrivilege complex type.
57 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
IsAuthorized: Specifies a Boolean that is set to true if the function is assigned to the principal.
Function privileges are either on or off (authorized or not authorized).
PrincipalId: Specifies the Identifier of the principal in the function privilege assignment.
PrincipalType: Specifies the PrincipalType of the principal in the function privilege assignment.
2.2.4.81 Group
The Group complex type specifies a security group that is associated with MDS.
The following is the XSD schema definition of the Group complex type.
<xs:complexType name="Group">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element
xmlns:q20="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="GroupType" type="q20:GroupType" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="SID" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SecurityPrivilege" nillable="true"
type="tns:SecurityPrivileges" />
<xs:element minOccurs="0" name="UserAssignments" nillable="true"
type="tns:ArrayOfIdentifier" />
</xs:sequence>
</xs:complexType>
Description: Specifies a description of the security group that is sourced from an Active Directory
directory or a local security account manager (SAM).
58 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
SID: Specifies the security identifier (SID) of the group from Windows.
SecurityPrivilege: Specifies a SecurityPrivileges complex type that contains the set of MDS
privileges that are assigned to the group.
UserAssignments: Specifies an ArrayOfIdentifier complex type that contains the set of user
identifiers that are assigned to the security group.
2.2.4.82 HierarchyMemberPrivilege
The following is the XSD schema definition of the HierarchyMemberPrivilege complex type.
<xs:complexType name="HierarchyMemberPrivilege">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q23="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="HierarchyType" type="q23:HierarchyType" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="IsModelAdministrator" type="xs:boolean" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q24="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q24:Permission" />
<xs:element minOccurs="0" name="PrincipalId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q25="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="PrincipalType" type="q25:PrincipalType" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
EntityId: Specifies the Identifier of the entity that is associated with the security privilege of the
hierarchy member.
HierarchyId: Specifies the Identifier of the hierarchy that is associated with the security privilege
of the hierarchy member.
HierarchyType: Specifies the HierarchyType (explicit or derived) of the hierarchy that is associated
with the security privilege of the hierarchy member.
Identifier: Specifies the Identifier of the privilege assignment of the hierarchy member.
59 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MemberId: Specifies the Identifier of the master data member that is associated with the security
privilege of the hierarchy member.
ModelId: Specifies the Identifier of the model that is associated with the security privilege of the
hierarchy member.
Permission: Specifies the Permission that is assigned for the member and security principal.
2.2.4.83 Identifier
The Identifier complex type specifies a set of IDs for a master data model object, including a
globally unique identifier (GUID) and unique name within context.
The following is the XSD schema definition of the Identifier complex type.
<xs:complexType name="Identifier">
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="ser:guid" />
<xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="InternalId" type="xs:int" />
</xs:sequence>
</xs:complexType>
Id: Specifies a GUID that uniquely identifies the object across all instances and contexts.
Name: Specifies a descriptive name that uniquely identifies the object within its context only.
InternalId: Specifies an integer ID that uniquely identifies an object within an MDS instance. This
value MUST NOT be used. Id SHOULD be used instead of InternalId.
2.2.4.84 Collection
The Collection complex type specifies a collection member that is a parent of another master data
member.
The following is the XSD schema definition of the Collection complex type.
<xs:complexType name="Collection">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q39="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q39:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="CollectionId" nillable="true"
type="q39:MemberIdentifier" />
<xs:element minOccurs="0" name="Remove" type="xs:boolean" />
<xs:element minOccurs="0" name="SortOrder" type="xs:int" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
60 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Remove: Specifies a Boolean value that is set to true in Update operations to remove a member
from the identified parent collection.
SortOrder: Specifies the sort order for related member of the collection.
2.2.4.85 MDMErrorContext
The MDMErrorContext complex type specifies the context of a particular error. This type identifies
the object that was operated on when the error occurred.
The following is the XSD schema definition of the MDMErrorContext complex type.
<xs:complexType name="MDMErrorContext">
<xs:sequence>
<xs:element minOccurs="0" name="FullyQualifiedName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Type" type="tns:ObjectType" />
</xs:sequence>
</xs:complexType>
FullyQualifiedName: Specifies the fully qualified name of an object (for example, sufficient context
to uniquely identify the object).
Identifier: Specifies the Identifier of the object that is involved in the error.
Type: Specifies the ObjectType of the object that is involved in the error.
2.2.4.86 MdmDataContractOfDerivedHierarchyContextIdentifier
<xs:complexType name="MdmDataContractOfDerivedHierarchyContextIdentifier">
<xs:annotation>
<xs:appinfo>
<GenericType Name="MdmDataContractOf{0}"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="DerivedHierarchyContextIdentifier"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Identifier" nillable="true"
type="tns:DerivedHierarchyContextIdentifier" />
<xs:element
xmlns:q42="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q42:PermissionType" />
61 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.87 MdmDataContractOfEntityContextIdentifier
<xs:complexType name="MdmDataContractOfEntityContextIdentifier">
<xs:annotation>
<xs:appinfo>
<GenericType Name="MdmDataContractOf{0}"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="EntityContextIdentifier"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Identifier" nillable="true"
type="tns:EntityContextIdentifier" />
<xs:element
xmlns:q43="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q43:PermissionType" />
</xs:sequence>
</xs:complexType>
2.2.4.88 MdmDataContractOfIdentifier
The MdmDataContractOfIdentifier complex type specifies the data contract for identifiers,
including helper types such as AuditInfo and Permission.
The following is the XSD schema definition for the MdmDataContractOfIdentifier complex type.
<xs:complexType name="MdmDataContractOfIdentifier">
<xs:annotation>
<xs:appinfo>
62 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.89 MdmDataContractOfMemberTypeContextIdentifier
<xs:complexType name="MdmDataContractOfMemberTypeContextIdentifier">
<xs:annotation>
<xs:appinfo>
<GenericType Name="MdmDataContractOf{0}"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="MemberTypeContextIdentifier"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Identifier" nillable="true"
type="tns:MemberTypeContextIdentifier" />
<xs:element
xmlns:q38="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q38:PermissionType" />
</xs:sequence>
</xs:complexType>
63 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.90 MdmDataContractOfModelContextIdentifier
<xs:complexType name="MdmDataContractOfModelContextIdentifier">
<xs:annotation>
<xs:appinfo>
<GenericType Name="MdmDataContractOf{0}"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
<GenericParameter Name="ModelContextIdentifier"
Namespace="http://schemas.microsoft.com/office/mdm/2007/11" />
</GenericType>
</xs:appinfo>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Identifier" nillable="true"
type="tns:ModelContextIdentifier" />
<xs:element
xmlns:q40="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q40:PermissionType" />
</xs:sequence>
</xs:complexType>
2.2.4.91 MDMError
The MDMError complex type specifies an information container for an error that occurred during
the processing of a request.
The following is the XSD schema definition of the MDMError complex type.
<xs:complexType name="MDMError">
<xs:sequence>
<xs:element minOccurs="0" name="Code" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Context" nillable="true" type="tns:MDMErrorContext" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
64 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.92 Member
The Member complex type specifies a master data member or row of data.
The following is the XSD schema definition of the Member complex type.
<xs:complexType name="Member">
<xs:sequence>
<xs:element minOccurs="0" name="Attributes" nillable="true" type="tns:ArrayOfAttribute"
/>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Collections" nillable="true"
type="tns:ArrayOfCollection" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element minOccurs="0" name="Parents" nillable="true" type="tns:ArrayOfParent" />
<xs:element
xmlns:q5="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContracts
" minOccurs="0" name="SecurityPermission" nillable="true" type="q5:SecurityPermission" />
<xs:element
xmlns:q6="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContracts
" minOccurs="0" name="ValidationStatus" type="q6:ValidationStatus" />
</xs:sequence>
</xs:complexType>
AuditInfo: Specifies the AuditInfo complex type. This property is always read-only.
Parents: Specifies an ArrayOfParent that includes parents of the member from explicit hierarchies.
SecurityPermission: Specifies the authorization of the user for the member. This property is
always read-only.
ValidationStatus: Specifies the ValidationStatus simple type. This property is always read-only.
2.2.4.93 MemberAttributeIdentifier
The MemberAttributeIdentifier complex type specifies the attribute that identifies errors in
EntityMember operations. The MemberAttributeIdentifier is a known identifier type.
The following is the XSD schema definition of the MemberAttributeIdentifier complex type.
<xs:complexType name="MemberAttributeIdentifier">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q13="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q13:MemberTypeContextIdentifier">
65 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MemberId: Specifies the attribute that caused the current issue in a MDS member that is passed in
the request.
2.2.4.94 MemberIdentifier
The MemberIdentifier complex type specifies a set of IDs for a master data member, including the
code and name of the member and the member type.
This complex type is an extension of the base type Identifier. In this case, the inherited ID property
MUST NOT be used.
The following is the XSD schema definition of the MemberIdentifier complex type.
<xs:complexType name="MemberIdentifier">
<xs:complexContent mixed="false">
<xs:extension base="tns:Identifier">
<xs:sequence>
<xs:element name="Code" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="MemberType" type="tns:MemberType" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
Code: Specifies the user key of the master data member that is unique within the context of the
entity.
2.2.4.95 MemberTypeContextIdentifier
The MemberTypeContextIdentifier complex type specifies a set of IDs for a master data model
object that exists in the context of an entity and member type. This type includes identifiers for the
context of the object, including parent entity, member type, and model. Examples of objects that
have an entity and member type context are attributes, attribute groups, and business rules.
The following is the XSD schema definition of the MemberTypeContextIdentifier complex type.
66 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.96 Metadata
The Metadata complex type specifies a superset of all container objects within the MDS system.
The following is the XSD schema definition of the Metadata complex type.
<xs:complexType name="Metadata">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeGroups" nillable="true"
type="tns:ArrayOfAttributeGroup" />
<xs:element minOccurs="0" name="Attributes" nillable="true"
type="tns:ArrayOfMetaDataAttribute" />
<xs:element minOccurs="0" name="DerivedHierarchies" nillable="true"
type="tns:ArrayOfDerivedHierarchy" />
<xs:element minOccurs="0" name="DerivedHierarchyLevels" nillable="true"
type="tns:ArrayOfDerivedHierarchyLevel" />
<xs:element minOccurs="0" name="Entities" nillable="true" type="tns:ArrayOfEntity" />
<xs:element minOccurs="0" name="ExplicitHierarchies" nillable="true"
type="tns:ArrayOfExplicitHierarchy" />
<xs:element minOccurs="0" name="Models" nillable="true" type="tns:ArrayOfModel" />
<xs:element minOccurs="0" name="VersionFlags" nillable="true"
type="tns:ArrayOfVersionFlag" />
<xs:element minOccurs="0" name="Versions" nillable="true" type="tns:ArrayOfVersion" />
</xs:sequence>
</xs:complexType>
67 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The MetadataAttribute complex type specifies an attribute for an entity within the MDS system.
The following is the XSD schema definition of the MetadataAttribute complex type.
<xs:complexType name="MetadataAttribute">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q201="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q201:MdmDataContractOfMemberTypeContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeType" nillable="true"
type="q201:AttributeType">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="ChangeTrackingGroup" type="xs:int" />
<xs:element minOccurs="0" name="DataType" type="q201:AttributeDataType">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="DataTypeInformation" nillable="true" type="xs:int"
/>
<xs:element minOccurs="0" name="DisplayWidth" type="xs:int" />
<xs:element minOccurs="0" name="DomainEntityId" nillable="true"
type="q201:Identifier">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="DomainEntityIsFlat" type="xs:boolean" />
<xs:element minOccurs="0" name="DomainEntityPermission" type="q201:PermissionType">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="FullyQualifiedName" nillable="true"
type="xs:string" />
<xs:element minOccurs="0" name="InputMaskId" nillable="true"
type="q201:Identifier">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
68 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
AttributeType:
DataTypeInformation:
DisplayWidth: Display width in picas for the attribute in the web UI.
DomainEntityIsFlat: Boolean hierarchy support for the entity attribute is associated with.
SortOrder: Order of the attribute in the collection. This can be per attribute group depending on
the request.
2.2.4.98 Model
The Model complex type specifies the highest level of data organization. Model contains all the
members, entities, attributes, hierarchy relationships, collections, business rules, and versions that
describe an aspect of the business. Model extends the MdmDataContractOfIdentifier complex type.
The following is the XSD schema definition of the Model complex type.
<xs:complexType name="Model">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="DerivedHierarchies" nillable="true"
type="tns:ArrayOfDerivedHierarchy" />
69 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.99 ModelContextIdentifier
The ModelContextIdentifier complex type specifies 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.
The following is the XSD schema definition of the ModelContextIdentifier complex type.
<xs:complexType name="ModelContextIdentifier">
<xs:complexContent mixed="false">
<xs:extension base="tns:Identifier">
<xs:sequence>
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
2.2.4.100 ModelPrivilege
The ModelPrivilege complex type specifies a model/object level privilege within the MDS system.
70 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:complexType name="ModelPrivilege">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="IsModelAdministrator" type="xs:boolean" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ObjectId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q26="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="ObjectType" type="q26:ModelObjectType" />
<xs:element
xmlns:q27="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q27:Permission" />
<xs:element minOccurs="0" name="PrincipalId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q28="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="PrincipalType" type="q28:PrincipalType" />
</xs:sequence>
</xs:complexType>
2.2.4.101 OperationResult
The OperationResult complex type specifies a standard container for all operation responses that
includes a list of errors.
The following is the XSD schema definition of the OperationResult complex type.
<xs:complexType name="OperationResult">
<xs:sequence>
<xs:element minOccurs="0" name="Errors" nillable="true" type="tns:ArrayOfMDMError" />
<xs:element minOccurs="0" name="RequestId" type="ser:guid" />
</xs:sequence>
</xs:complexType>
71 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.102 Parent
The Parent complex type specifies a member that is a parent or a prior sibling of another master
data member within an explicit hierarchy.
The following is the XSD schema definition of the Parent complex type.
<xs:complexType name="Parent">
<xs:sequence>
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ParentId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element
xmlns:q7="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContracts
" minOccurs="0" name="RelationshipType" nillable="true" type="q7:RelationshipType" />
</xs:sequence>
</xs:complexType>
2.2.4.103 ParentChild
The ParentChild complex type specifies a parent-child relationship record from a hierarchy.
The following is the XSD schema definition of the ParentChild complex type.
<xs:complexType name="ParentChild">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q406="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q406:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true"
type="q406:Identifier">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="q406:AuditInfo">
<xs:annotation>
<xs:appinfo>
72 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
73 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ChildPermission: Specifies the SecurityPermission of the user for the child member.
NextRelationshipType: Specifies the Hierarchy Item Type of the next member in the hierarchy.
ParentPermission: Specifies the SecurityPermission of the user for the parent member.
RelationshipId: Specifies the Identifier of the object (attribute or hierarchy) that associates one
node with another.
RelationshipType: Specifies the Hierarchy Item Type of the current member in the hierarchy.
SortOrder: Specifies an integer that represents the order of the child member among its siblings,
relative to the parent.
2.2.4.104 SecurityPrincipalsCriteria
The following is the XSD schema definition of the SecurityPrincipalsCriteria complex type.
<xs:complexType name="SecurityPrincipalsCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="All" type="xs:boolean" />
<xs:element minOccurs="0" name="FunctionPrivilege" type="tns:ResultType" />
<xs:element minOccurs="0" name="HierarchyMemberPrivilege" type="tns:ResultType" />
<xs:element minOccurs="0" name="Identifiers" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="ModelPrivilege" type="tns:ResultType" />
<xs:element minOccurs="0" name="ResultType" type="tns:ResultType" />
74 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
All: Specifies a Boolean value that is used to return all principal items in a response.
2.2.4.105 SecurityPrincipals
The SecurityPrincipals complex type specifies a set of users and user groups.
The following is the XSD schema definition of the SecurityPrincipals complex type.
<xs:complexType name="SecurityPrincipals">
<xs:sequence>
<xs:element minOccurs="0" name="Groups" nillable="true" type="tns:ArrayOfGroup" />
<xs:element minOccurs="0" name="Users" nillable="true" type="tns:ArrayOfUser" />
</xs:sequence>
</xs:complexType>
2.2.4.106 SecurityPrivileges
The SecurityPrivileges complex type specifies a set of security privilege assignments at the
function, model object, and member levels.
The following is the XSD schema definition of the SecurityPrivileges complex type.
<xs:complexType name="SecurityPrivileges">
<xs:sequence>
<xs:element minOccurs="0" name="FunctionPrivileges" nillable="true"
type="tns:ArrayOfFunctionPrivilege" />
75 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.107 StagingBatch
The StagingBatch complex type specifies a container for a staging batch, including the batch
identification, errors, statistics, and members.
The following is the XSD schema definition of the StagingBatch complex type.
<xs:complexType name="StagingBatch">
<xs:sequence>
<xs:element minOccurs="0" name="BatchId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Errors" nillable="true"
type="tns:ArrayOfStagingBatchError" />
<xs:element minOccurs="0" name="Information" nillable="true"
type="tns:StagingBatchInformation" />
<xs:element minOccurs="0" name="Members" nillable="true"
type="tns:ArrayOfEntityMembers" />
</xs:sequence>
</xs:complexType>
2.2.4.108 StagingBatchError
The StagingBatchError complex type specifies a process error that is associated with a member in
a staging batch.
The following is the XSD schema definition of the StagingBatchError complex type.
<xs:complexType name="StagingBatchError">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
76 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
AttributeId: Specifies the Identifier of the attribute that is being updated. This property is
applicable only for attribute value updates.
HierarchyId: Specifies the Identifier of the hierarchy that is being updated. This property is
applicable only for hierarchy parent or sibling updates.
2.2.4.109 StagingBatchInformation
The following is the XSD schema definition of the StagingBatchInformation complex type.
<xs:complexType name="StagingBatchInformation">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q482="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q482:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="BatchId" nillable="true" type="q482:Identifier">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="LastRunEndDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="LastRunStartDate" type="xs:dateTime" />
<xs:element minOccurs="0" name="MemberAttributeErrorCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberAttributeTotalCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberErrorCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberRelationshipErrorCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberRelationshipTotalCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberTotalCount" type="xs:int" />
<xs:element minOccurs="0" name="ModelName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PriorBatchId" nillable="true"
type="q482:Identifier">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
</xs:appinfo>
</xs:annotation>
77 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MemberErrorCount: Specifies the number of member Create operations that resulted in errors.
MemberTotalCount: Specifies the number of member Create operations that were attempted.
PriorBatchId: Specifies the Identifier of a prior attempted batch if the current batch is a reload of
the prior batch's corrected error records.
SourceId: Specifies an optional Identifier to associate the batch with a source system.
2.2.4.110 StagingUnbatchedInformation
The following is the XSD schema definition of the StagingUnbatchedInformation complex type.
<xs:complexType name="StagingUnbatchedInformation">
<xs:sequence>
<xs:element minOccurs="0" name="MemberAttributeCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberRelationshipCount" type="xs:int" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
MemberAttributeCount: Specifies the number of unbatched staging records for attribute updates.
MemberCount: Specifies the number of unbatched staging records for member creations.
78 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ModelId: Specifies the Identifier of the target model for the unbatched staging records.
2.2.4.111 SystemSetting
The SystemSetting complex type specifies a single setting within the MDM system. These settings
SHOULD be a member of a SystemSettingGroup.
The following is the XSD schema definition of the SystemSetting complex type.
<xs:complexType name="SystemSetting">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="DataType" type="tns:AttributeDataType" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DisplayName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DisplaySequence" type="xs:int" />
<xs:element minOccurs="0" name="IsVisible" type="xs:boolean" />
<xs:element minOccurs="0" name="MaxValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="MinValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SettingType" type="tns:AttributeType" />
<xs:element minOccurs="0" name="SettingValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SystemDomainList" nillable="true"
type="tns:SystemDomainList" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
IsVisible: A Boolean flag that determines whether the setting is visible in the MDS configuration
screen.
MaxValue: A string that constrains the maximum possible value for the setting.
MinValue: A string that constrains the minimum possible value for the setting.
2.2.4.112 SystemSettingGroup
The SystemSettingGroup complex type specifies a group of related system settings that manage
system level functionality within MDS.
The following is the XSD schema definition of the SystemSettingGroup complex type.
79 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
DisplaySequence: Specifies the sequence in which the setting groups are most logically displayed.
2.2.4.113 Transaction
The following is the XSD schema definition of the Transaction complex type.
<xs:complexType name="Transaction">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Date" type="xs:dateTime" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ExplicitHierarchyId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element minOccurs="0" name="MemberType" type="tns:MemberType" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="NewValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PriorValue" nillable="true" type="xs:string" />
<xs:element
xmlns:q18="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="TransactionType" type="q18:TransactionType" />
<xs:element minOccurs="0" name="UserId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
AttributeId: Specifies the Identifier of the attribute that is updated in the transaction (if
applicable).
EntityId: Specifies the Identifier of the entity that is updated in the transaction.
80 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MemberId: Specifies the Identifier of the master data member that is updated in the transaction.
ModelId: Specifies the Identifier of the model that is updated in the transaction.
UserId: Specifies the Identifier of the user who created the transaction.
VersionId: Specifies the Identifier of the version that is updated in the transaction.
2.2.4.114 User
The User complex type specifies an Active Directory user who has specific privileges assigned.
These privileges were either inherited from an Active Directory group or directly assigned.
The following is the XSD schema definition of the User complex type.
<xs:complexType name="User">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="DisplayName" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EmailAddress" nillable="true" type="xs:string" />
<xs:element
xmlns:q29="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="EmailFormat" type="q29:EmailFormat" />
<xs:element minOccurs="0" name="GroupPrivileges" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="Identifier" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="LastLogOn" type="xs:dateTime" />
<xs:element minOccurs="0" name="LoggedIn" type="xs:boolean" />
<xs:element minOccurs="0" name="SID" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SecurityPrivilege" nillable="true"
type="tns:SecurityPrivileges" />
</xs:sequence>
</xs:complexType>
EmailAddress: Specifies a valid e-mail address that is associated with the user.
81 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.4.115 ValidationIssue
The ValidationIssue complex type specifies a validation issue that is recorded against a master
data member and attribute based on a validation business rule.
The following is the XSD schema definition of the ValidationIssue complex type.
<xs:complexType name="ValidationIssue">
<xs:sequence>
<xs:element minOccurs="0" name="AuditInfo" nillable="true" type="tns:AuditInfo" />
<xs:element minOccurs="0" name="BusinessRuleId" nillable="true" type="tns:Identifier"
/>
<xs:element minOccurs="0" name="BusinessRuleItemId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="Id" type="xs:int" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="NotificationSent" type="xs:boolean" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
BusinessRuleId: Specifies the Identifier of the business rule that created the validation issue.
BusinessRuleItemId: Specifies the Identifier of the action in the business rule that created the
validation issue.
EntityId: Specifies the Identifier of the entity that is associated with the validation issue.
HierarchyId: Specifies the Identifier of the hierarchy that is associated with the validation issue
(if applicable).
MemberId: Specifies the MemberIdentifier of the master data member that is associated with the
validation issue.
ModelId: Specifies the Identifier of the model that is associated with the validation issue.
82 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
VersionId: Specifies the Identifier of the version that is associated with the validation issue.
2.2.4.116 Version
The Version complex type specifies a snapshot that contains all model members, attributes,
hierarchies, and collections for a model, usually denoting a specific time period. Version extends
the MdmDataContractOfModelContextIdentifier complex type.
The following is the XSD schema definition of the Version complex type.
<xs:complexType name="Version">
<xs:complexContent mixed="false">
<xs:extension base="tns:MdmDataContractOfModelContextIdentifier">
<xs:sequence>
<xs:element minOccurs="0" name="CopiedFromVersionId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="Description" nillable="true" type="xs:string" />
<xs:element
xmlns:q45="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="ValidationStatus" type="q45:VersionValidationStatus" />
<xs:element minOccurs="0" name="VersionFlagId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionNumber" type="xs:int" />
<xs:element
xmlns:q46="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="VersionStatus" type="q46:VersionStatus" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
ValidationStatus: Specifies the cumulative business rule evaluation status of the version.
VersionNumber: Specifies the integer identifier for the version. This value is set by the system.
2.2.4.117 VersionFlag
The VersionFlag complex type specifies tags that provide a standard identifier that can be attached
to a version to reduce integration rework. These identifiers can be limited to only committed
versions or can be available to all versions based on a Boolean setting.
The following is the XSD schema definition of the VersionFlag complex type.
<xs:complexType name="VersionFlag">
83 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
IsCommittedOnly: Specifies a Boolean flag that indicates the type of version that this flag can
identify.
The following table summarizes the set of common XML schema simple type definitions that are
defined by this specification. XML schema simple type definitions that are specific to a particular
operation are described with the operation.
BREntityMemberType Specifies the type of entity member that is associated with a business rule.
BRPropertyName Specifies the name that identifies a property within a business rule component.
DisplayType Specifies the chosen display format for domain-based attribute (DBA) columns
[Code, Code {Name}, Name {Code}].
EmailFormat Specifies the preferred e-mail delivery format that is associated with a user.
ExportViewFormat Specifies the type of export view format. Export views are available in a known
set of standard formats.
FunctionalArea Specifies the MDS application functional area. Functional areas are used for
assigning functional security authorizations.
HierarchyItemType Specifies the type of component that is used by a level of a derived hierarchy.
84 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
LogicalOperator Specifies the logical operator that is used to join multiple business rule
conditions.
MemberKeyLookupType Specifies the type of key that is supplied in a member lookup: the member code
or internal integer ID.
MemberReturnOption Specifies which member data is returned when querying master data members:
the data, the row counts, or both.
ModelObjectType Specifies the type of master data model object (metadata only).
Permission Specifies the permission that is assigned to a principal for accessing an MDS
function, object, or data member.
PermissionType Specifies the effective permission that is assigned to a principal for accessing an
MDS object.
ResultType Specifies the level of detail to return for model object queries. The result type is
used in association with a particular object type.
SecurityPermission Specifies the effective security permission for a user of an MDS object.
StagingDataStatus Specifies a status that indicates the success or failure of staging records.
SystemPropertyType Specifies the identifying name of one of the available system properties.
2.2.5.1 AttributeType
85 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:simpleType name="AttributeType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="FreeForm" />
<xs:enumeration value="Domain" />
<xs:enumeration value="System" />
<xs:enumeration value="File" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.2 AttributeValueType
The following is the XSD schema definition of the AttributeValueType simple type.
<xs:simpleType name="AttributeValueType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="String" />
<xs:enumeration value="Number" />
<xs:enumeration value="DateTime" />
<xs:enumeration value="Domain" />
<xs:enumeration value="File" />
</xs:restriction>
</xs:simpleType>
Value Meaning
86 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
2.2.5.3 BREntityMemberType
The BREntityMemberType simple type specifies the type of entity member that is associated with
a business rule.
The following is the XSD schema definition of the BREntityMemberType simple type.
<xs:simpleType name="BREntityMemberType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="Leaf" />
<xs:enumeration value="Consolidated" />
<xs:enumeration value="Collection" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Leaf The members are leaf members. These members do not have children in explicit
hierarchies.
Consolidated The members are consolidated members that participate in explicit hierarchies. These
members may have children in explicit hierarchies.
2.2.5.4 BRItemType
The BRItemType simple type specifies the selected business rule condition or action.
The following is the XSD schema definition of the BRItemType simple type.
<xs:simpleType name="BRItemType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="IsEqual" />
<xs:enumeration value="IsNotEqual" />
<xs:enumeration value="Contains" />
<xs:enumeration value="StartsWith" />
<xs:enumeration value="EndsWith" />
<xs:enumeration value="ContainsSubset" />
<xs:enumeration value="IsGreaterThan" />
87 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
88 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
DefaultsToValue Data Generation Action: Set the attribute to a value when it is blank.
EqualsConcatenatedValue Data Generation Action: Set the attribute to a value that is concatenated
from multiple other attributes/values.
89 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
value.
AllowableValues Validation Action: An attribute is invalid if not equal to one of the allowed
values.
Unique Validation Action: An attribute is invalid if not unique across all entity
members.
DefaultsToConcatenatedValue Data Generation Action: Set the attribute to a value that is concatenated
from multiple other attributes/values if the attribute is blank.
HasChanged Condition: This is true when an attribute in the specified change tracking
group has been updated. After completion the flag will be returned to not
changed.
2.2.5.5 BRPropertyName
The BRPropertyName simple type specifies the name that identifies a property within a business
rule component.
The following is the XSD schema definition of the BRPropertyName simple type.
<xs:simpleType name="BRPropertyName">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="Value" />
<xs:enumeration value="StartPosition" />
<xs:enumeration value="RangeLow" />
<xs:enumeration value="RangeHigh" />
<xs:enumeration value="StartingValue" />
90 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
Anchor The attribute that is associated with the business rule is specified.
2.2.5.6 BRStatus
The BRStatus simple type specifies the update and publication status of a business rule.
The following is the XSD schema definition of the BRStatus simple type.
<xs:simpleType name="BRStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="New" />
<xs:enumeration value="Active" />
<xs:enumeration value="Excluded" />
<xs:enumeration value="PendingActivation" />
<xs:enumeration value="PendingChanges" />
<xs:enumeration value="PendingExclusion" />
<xs:enumeration value="PendingDeletion" />
</xs:restriction>
</xs:simpleType>
Value Meaning
91 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Excluded The rule is explicitly excluded from the published set of rules.
PendingActivation The rule has been created and will be published with the next publish request for the
related entity and member type.
PendingChanges The rule has been updated, and the new rule will be published with the next publish
request for the related entity and member type. Until then, the prior version of the
rule is active.
PendingExclusion The rule has been marked for exclusion and will be excluded with the next publish
request for the related entity and member type. Until then, the prior version of the
rule is active.
PendingDeletion The rule has been marked for deletion and will be deleted with the next publish
request for the related entity and member type. Until then, the prior version of the
rule is active.
2.2.5.7 DisplayType
The DisplayType simple type specifies the chosen display format for domain-based attribute (DBA)
columns [Code, Code {Name}, Name {Code}].
The following is the XSD schema definition of the DisplayType simple type.
<xs:simpleType name="DisplayType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="Code" />
<xs:enumeration value="CodeName" />
<xs:enumeration value="NameCode" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.8 EmailFormat
The EmailFormat simple type specifies the preferred e-mail delivery format that is associated with
a user.
The following is the XSD schema definition of the EmailFormat simple type.
92 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
HTML The e-mail format is HTML that may include hyperlink references.
2.2.5.9 ExportViewFormat
The ExportViewFormat simple type specifies the type of export view format. Export views are
available in a known set of standard formats.
The following is the XSD schema definition of the ExportViewFormat simple type.
<xs:simpleType name="ExportViewFormat">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="LeafAttributes" />
<xs:enumeration value="ConsolidatedAttributes" />
<xs:enumeration value="CollectionAttributes" />
<xs:enumeration value="Collections" />
<xs:enumeration value="ExplicitParentChild" />
<xs:enumeration value="ExplicitLevels" />
<xs:enumeration value="DerivedParentChild" />
<xs:enumeration value="DerivedLevels" />
</xs:restriction>
</xs:simpleType>
Value Meaning
LeafAttributes This is a view that contains leaf members and their attributes.
ConsolidatedAttributes This is a view that contains consolidated members and their attributes.
CollectionAttributes This is a view that contains collection entity members and their attributes.
93 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ExplicitParentChild This is a view that contains explicit hierarchy relationships for an entity in
parent-child format.
ExplicitLevels This is a view that contains explicit hierarchy relationships for an entity in level-
based format.
DerivedParentChild This is a view that contains derived hierarchy relationships for a selected
hierarchy in parent-child format.
DerivedLevels This is a view that contains derived hierarchy relationships for a selected
hierarchy in level-based format.
2.2.5.10 FunctionalArea
The FunctionalArea simple type specifies the MDS application functional area. Functional areas are
used for assigning functional security authorizations.
The following is the XSD schema definition of the FunctionalArea simple type.
<xs:simpleType name="FunctionalArea">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Explorer" />
<xs:enumeration value="Versions" />
<xs:enumeration value="ImportExport" />
<xs:enumeration value="Reporting" />
<xs:enumeration value="Security" />
<xs:enumeration value="SystemAdministration" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Explorer This value specifies the Explorer functional area for viewing and updating master
data.
Versions This value specifies the Versions functional area for managing model versions
and validation processing.
ImportExport This value specifies the Import and Export functional area for bulk importing
and exporting of master data.
Reporting This value specifies the Reporting functional area for running reports.
Security This value specifies the Security functional area for managing MDS permission
assignments.
SystemAdministration This value specifies the System Administration functional area for managing
model structure, business rules, and system settings.
94 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The GroupType simple type specifies the type (source) of a security group.
The following is the XSD schema definition of the GroupType simple type.
<xs:simpleType name="GroupType">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="MDMInternalGroup" />
<xs:enumeration value="ActiveDirectoryGroup" />
<xs:enumeration value="SharepointGroup" />
<xs:enumeration value="SharepointAudience" />
<xs:enumeration value="OtherGroup">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">99</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.12 HierarchyItemType
The HierarchyItemType simple type specifies the type of component that is used by a level of a
derived hierarchy.
The following is the XSD schema definition of the HierarchyItemType simple type.
<xs:simpleType name="HierarchyItemType">
<xs:restriction base="xs:string">
<xs:enumeration value="Entity" />
<xs:enumeration value="DBA" />
<xs:enumeration value="Hierarchy" />
<xs:enumeration value="ConsolidatedDBA" />
95 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.5.13 HierarchyType
The following is the XSD schema definition of the HierarchyType simple type.
<xs:simpleType name="HierarchyType">
<xs:restriction base="xs:string">
<xs:enumeration value="Explicit" />
<xs:enumeration value="Derived" />
<xs:enumeration value="Collection" />
<xs:enumeration value="All" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Derived All attribute-based derived hierarchies for the specified entity or entities.
2.2.5.14 LogicalOperator
The LogicalOperator simple type specifies the logical operator that is used to join multiple
business rule conditions.
The following is the XSD schema definition of the LogicalOperator simple type.
<xs:simpleType name="LogicalOperator">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
96 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.5.15 MemberKeyLookupType
The MemberKeyLookupType simple type specifies the type of key that is supplied in a member
lookup: the member code or the internal integer ID.
The following is the XSD schema definition of the MemberKeyLookupType simple type.
<xs:simpleType name="MemberKeyLookupType">
<xs:restriction base="xs:string">
<xs:enumeration value="MemberCode" />
<xs:enumeration value="MemberId" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.16 MemberReturnOption
The MemberReturnOption simple type specifies which member data is returned when querying
master data members: the data, the row counts, or both.
The following is the XSD schema definition of the MemberReturnOption simple type.
<xs:simpleType name="MemberReturnOption">
<xs:restriction base="xs:string">
<xs:enumeration value="Data" />
<xs:enumeration value="Counts" />
<xs:enumeration value="DataAndCounts" />
</xs:restriction>
</xs:simpleType>
97 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.5.17 MemberType
The MemberType simple type specifies the type of member record within an entity.
The following is the XML schema definition of the MemberType simple type.
<xs:simpleType name="MemberType">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="Leaf" />
<xs:enumeration value="Consolidated" />
<xs:enumeration value="Collection" />
<xs:enumeration value="Hierarchy" />
<xs:enumeration value="CollectionMember" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Leaf The members are leaf members. These members do not have children in explicit
hierarchies.
Consolidated The members are consolidated members that participate in explicit hierarchies. These
members may have children in explicit hierarchies.
2.2.5.18 ModelObjectType
The ModelObjectType simple type specifies the type of master data model object (for metadata
only).
The following is the XSD schema definition of the ModelObjectType simple type.
<xs:simpleType name="ModelObjectType">
<xs:restriction base="xs:string">
98 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
99 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.5.19 ObjectType
The ObjectType simple type specifies the type of master data model object.
The following is the XSD schema definition of the ObjectType simple type.
<xs:simpleType name="ObjectType">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown" />
<xs:enumeration value="Model" />
<xs:enumeration value="DerivedHierarchy" />
<xs:enumeration value="DerivedHierarchyLevel" />
<xs:enumeration value="Version" />
<xs:enumeration value="Entity" />
<xs:enumeration value="Hierarchy" />
<xs:enumeration value="Attribute" />
<xs:enumeration value="AttributeGroup" />
<xs:enumeration value="StagingBatch" />
<xs:enumeration value="VersionFlag" />
<xs:enumeration value="User" />
<xs:enumeration value="MemberCode" />
<xs:enumeration value="Annotation" />
100 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
Entity An entity.
Hierarchy A hierarchy.
Attribute An attribute.
Annotation An annotation.
2.2.5.20 Permission
The Permission simple type specifies the permission that is assigned to a principal for accessing an
MDS function, object, or data member.
101 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:simpleType name="Permission">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Deny" />
<xs:enumeration value="Update" />
<xs:enumeration value="ReadOnly" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.21 PermissionType
The PermissionType simple type specifies the effective permission that is assigned to a principal
for accessing an MDS object.
The following is the XSD schema definition of the PermissionType simple type.
<xs:simpleType name="PermissionType">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown" />
<xs:enumeration value="NotSpecified">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">99</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="DenyAccess">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="Update">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
102 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
103 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The PrincipalType simple type specifies the type of security principal (user or group).
The following is the XSD schema definition of the PrincipalType simple type.
<xs:simpleType name="PrincipalType">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="UserAccount" />
<xs:enumeration value="Group" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.23 RelationshipType
The RelationshipType simple type specifies the type of hierarchy relationship between members.
The following is the XSD schema definition of the RelationshipType simple type.
<xs:simpleType name="RelationshipType">
<xs:restriction base="xs:string">
<xs:enumeration value="All" />
<xs:enumeration value="Parent" />
<xs:enumeration value="Sibling" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.24 ResultType
The ResultType simple type specifies the level of detail to return for model object queries. The
result type is used in association with a particular object type.
104 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:simpleType name="ResultType">
<xs:restriction base="xs:string">
<xs:enumeration value="None" />
<xs:enumeration value="Identifiers" />
<xs:enumeration value="Details" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Identifiers Only identifier information and attributes of each object should be returned for a specified
type of object.
Details All details, including child objects, should be returned for a specified type of object.
2.2.5.25 SearchOption
The SearchOption simple type specifies the scope of metadata objects to be searched.
SearchOption allows the exclusion or inclusion of user-created objects and system objects.
The following is the XSD schema definition of the SearchOption simple type.
<xs:simpleType name="SearchOption">
<xs:restriction base="xs:string">
<xs:enumeration value="UserDefinedObjectsOnly" />
<xs:enumeration value="SystemObjectsOnly" />
<xs:enumeration value="BothUserDefinedAndSystemObjects" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.26 SecurityPermission
The SecurityPermission simple type specifies the effective security permission for a user of an
MDS object.
The following is the XSD schema definition of the SecurityPermission simple type.
105 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
Read Permission to view the element is provided, but the value cannot be changed.
2.2.5.27 SecurityResolutionType
The SecurityResolutionType simple type specifies the resolution specification when returning
security permissions. Permissions may be retrieved as they were assigned or in a net effective list of
permissions.
The following is the XSD schema definition of the SecurityResolutionType simple type.
<xs:simpleType name="SecurityResolutionType">
<xs:restriction base="xs:string">
<xs:enumeration value="UserAndGroup" />
<xs:enumeration value="Users" />
<xs:enumeration value="Effective" />
</xs:restriction>
</xs:simpleType>
106 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
UserAndGroup Return permissions that are assigned directly to the user and those that are assigned to
groups to which the user belongs.
Effective Return the effective set of permissions for the user, resolving the effects of overlaps.
2.2.5.28 SortDirection
The SortDirection simple type specifies the sort direction of a sorted column.
The following is the XSD schema definition of the TransactionType simple type.
<xs:simpleType name="SortDirection">
<xs:restriction base="xs:string">
<xs:enumeration value="Asc" />
<xs:enumeration value="Desc" />
</xs:restriction>
</xs:simpleType>
Value Meaning
2.2.5.29 StagingBatchStatus
The StagingBatchStatus simple type specifies the processing status of a staging (import) batch.
The following is the XSD schema definition of the StagingBatchStatus simple type.
<xs:simpleType name="StagingBatchStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="All" />
<xs:enumeration value="QueuedToRun" />
<xs:enumeration value="NotRunning" />
<xs:enumeration value="Running" />
<xs:enumeration value="QueuedToClear" />
<xs:enumeration value="Cleared" />
</xs:restriction>
</xs:simpleType>
Value Meaning
107 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
NotRunning The batch is not running and is not queued for processing.
2.2.5.30 StagingDataStatus
The StagingDataStatus simple type specifies a status that indicates the success or failure of
staging records.
The following is the XSD schema definition of the StagingDataStatus simple type.
<xs:simpleType name="StagingDataStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="All" />
<xs:enumeration value="Successful" />
<xs:enumeration value="Error" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Successful The status indicates staging records that were loaded successfully.
Error The status indicates staging records that did not load.
2.2.5.31 SystemPropertyType
The SystemPropertyType simple type specifies the identifying name of one of the available
system properties.
The following is the XSD schema definition of the SystemPropertyType simple type.
<xs:simpleType name="SystemPropertyType">
<xs:restriction base="xs:string">
<xs:enumeration value="DatabaseMaxSizeMB" />
<xs:enumeration value="DatabaseUsedSizeMB" />
</xs:restriction>
</xs:simpleType>
108 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
DatabaseMaxSizeMB This is the maximum size, in megabytes, that is allocated to the master data
database in SQL Server. This property is relevant only when the database size is
constrained.
DatabaseUsedSizeMB This is the currently used space, in megabytes, of the master data database in
SQL Server.
2.2.5.32 TransactionType
The TransactionType simple type specifies the type of member change that is identified in a
transaction.
The following is the XSD schema definition of the TransactionType simple type.
<xs:simpleType name="TransactionType">
<xs:restriction base="xs:string">
<xs:enumeration value="CreateMember">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="ChangeMemberStatus">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="SetAttributeValue">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="MoveMemberToParent">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue>
</xs:appinfo>
</xs:annotation>
</xs:enumeration>
<xs:enumeration value="MoveMemberToSibling">
<xs:annotation>
<xs:appinfo>
<EnumerationValue
xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue>
</xs:appinfo>
</xs:annotation>
109 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.5.33 ValidationStatus
The ValidationStatus simple type specifies the validation status of a master data member.
The following is the XSD schema definition of the ValidationStatus simple type.
<xs:simpleType name="ValidationStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="NewAwaitingValidation" />
<xs:enumeration value="Validating" />
<xs:enumeration value="AwaitingRevalidation" />
<xs:enumeration value="ValidationSucceeded" />
<xs:enumeration value="ValidationFailed" />
<xs:enumeration value="AwaitingDependentMemberRevalidation" />
<xs:enumeration value="AwaitingLevelRecalculation" />
</xs:restriction>
</xs:simpleType>
Value Meaning
NewAwaitingValidation The member has not been validated yet. This condition occurs
after a new business rule is added or members are staged into
the system.
110 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ValidationFailed This member has failed at least one active business rule.
2.2.5.34 VersionStatus
The following is the XSD schema definition of the VersionStatus simple type.
<xs:simpleType name="VersionStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="NotSpecified" />
<xs:enumeration value="Open" />
<xs:enumeration value="Locked" />
<xs:enumeration value="Committed" />
</xs:restriction>
</xs:simpleType>
Value Meaning
Open The version is an open version, meaning that users may make updates (security
permitting).
Locked The version is a locked version, meaning that users may not make updates and that
version administrators can perform final validations or revisions prior to committing.
Committed The version is a committed version, meaning that no changes may be made.
2.2.5.35 VersionValidationStatus
The following is the XSD schema definition of the VersionValidationStatus simple type.
<xs:simpleType name="VersionValidationStatus">
<xs:restriction base="xs:string">
<xs:enumeration value="Unknown" />
<xs:enumeration value="NotValidated" />
<xs:enumeration value="Validated" />
111 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Value Meaning
2.2.6 Attributes
This specification does not define any common XML schema attribute definitions.
2.2.7 Groups
This specification does not define any common XML schema group definitions.
This specification does not define any common XML schema attribute group definitions.
112 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
This section describes a conceptual model of possible data organization that an implementation
maintains to participate in this protocol. The described organization is provided to facilitate the
explanation of how the protocol behaves. This document does not mandate that implementations
adhere to this model as long as their external behavior is consistent with what is described in this
document.
An entity is a collection of leaf members, attributes, attribute groups, and (if explicit hierarchies
are enabled) a collection of consolidated members and conditions.
A derived hierarchy level is an entity that is connected by a domain-based attribute relationship.
A business rule is a collection of business rule actions and business rule conditions.
3.1.2 Timers
None.
3.1.3 Initialization
The server MUST start and begin listening for requests. All connections are stateless, so no further
initialization is required.
Operation Description
EntityMembersGet Retrieves a filtered set of members and their data from an entity.
113 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ModelMembersBulkUpdate Begins the asynchronous update of member data across one or more
entities.
StagingProcess Sweeps existing unbatched records in the staging tables into a batch
for processing and launches execution of the staging queue on request.
SecurityPrincipalsClone Creates exact copies of users, groups, and their permissions within the
security model from another source, while retaining the GUIDs of the
114 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
original objects.
SecurityPrincipalsCreate Creates new users, groups, and their permissions within the security
model.
SecurityPrivilegesClone Creates exact copies of permissions within the security model from
another source, while retaining the GUIDs of the original objects.
BusinessRulesClone Creates new business rules that are exact copies of business rules from
another source, while retaining the GUIDs of the original objects.
BusinessRulesPublish Publishes business rules for a model type, entity type, or member type.
115 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
already exists.
3.1.4.1 EntityMembersGet
The EntityMembersGet operation retrieves a filtered set of members and their data from an entity.
This operation is specialized to tabular retrieval of members and their attributes, and it is optimized
for retrieving small batches of members within a single entity. This operation does not return file
attribute file contents.
The EntityMembersGet operation is used to return member and hierarchy data as specified. This
operation is optimized for retrieval of a select subset of members within an entity. This operation is
used within the context of a single entity and single version. Results include member attributes and
hierarchy parents from associated hierarchies.
<wsdl:operation name="EntityMembersGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersGet" name="EntityMembersGetRequest" message="tns:EntityMembersGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersGetResponse" name="EntityMembersGetResponse" message="tns:EntityMembersGetResponse"
/>
</wsdl:operation>
3.1.4.1.1 Messages
The following WSDL message definitions are specific to the EntityMembersGet operation.
3.1.4.1.1.1 EntityMembersGetRequest
3.1.4.1.1.2 EntityMembersGetResponse
3.1.4.1.2 Elements
The following XML schema element definitions are specific to the EntityMembersGet operation.
3.1.4.1.2.1 EntityMembersGetRequest
116 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.1.2.2 EntityMembersGetResponse
The EntityMembersGetResponse element returns a response that contains one or more of the
following complex types:
EntityMembers
EntityMembersInformation
OperationResult
<xs:element name="EntityMembersGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q2="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityMembers" nillable="true" type="q2:EntityMembers" />
<xs:element xmlns:q3="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityMembersInformation" nillable="true" type="q3:EntityMembersInformation" />
<xs:element xmlns:q4="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q4:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the EntityMembersGet
operation.
3.1.4.1.3.1 EntityMembersGetCriteria
The EntityMembersGetCriteria request complex type specifies the EntityMembers criteria for the
operations result set.
The following is the XSD schema definition of the EntityMembersGetCriteria complex type.
<xs:complexType name="EntityMembersGetCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeGroupId" nillable="true" type="tns:Identifier"
/>
117 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Attributes: Specifies a list of desired attribute columns by GUID or name. If the AttributeGroup
complex type is specified, only columns within the attribute group may be specified. This value is
optional.
MemberType: Specifies leaf, parent, or collection members. This value is optional if EntityId is
specified.
PageNumber: Specifies the page number to retrieve based on the PageSize value. The default
value is 1.
ParentEntityId: Specifies the GUID or the exact name of the parent member's entity. This value is
required for derived hierarchies only and is ignored for explicit hierarchies and collections.
118 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
SortColumnId: Specifies the column on which the returned members are sorted. This value is
optional.
3.1.4.1.3.2 EntityMembersInformation
The following is the XSD schema definition of the EntityMembersInformation complex type.
<xs:complexType name="EntityMembersInformation">
<xs:sequence>
<xs:element minOccurs="0" name="MemberCount" type="xs:int" />
<xs:element minOccurs="0" name="PageNumber" type="xs:int" />
<xs:element minOccurs="0" name="TotalMemberCount" type="xs:int" />
<xs:element minOccurs="0" name="TotalPages" type="xs:int" />
</xs:sequence>
</xs:complexType>
MemberCount: Specifies the count of members based on the applied search term.
TotalMemberCount: Specifies the total number of visible records based on security and hierarchy
parent filter.
3.1.4.2 EntityMemberAttributesGet
<wsdl:operation name="EntityMemberAttributesGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAttributesGet" name="EntityMemberAttributesGetRequest"
message="tns:EntityMemberAttributesGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAttributesGetResponse" name="EntityMemberAttributesGetResponse"
message="tns:EntityMemberAttributesGetResponse" />
</wsdl:operation>
119 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following WSDL message definitions are specific to the EntityMemberAttributesGet operation.
3.1.4.2.1.1 EntityMemberAttributesGetRequest
3.1.4.2.1.2 EntityMemberAttributesGetResponse
3.1.4.2.2 Elements
The following XML schema element definitions are specific to the EntityMemberAttributesGet
operation.
3.1.4.2.2.1 EntityMemberAttributesGetRequest
<xs:element name="EntityMemberAttributesGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q5="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityMembers" nillable="true" type="q5:EntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.2.2.2 EntityMemberAttributesGetResponse
EntityMembers
OperationResult
<xs:element name="EntityMemberAttributesGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q6="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityMembers" nillable="true" type="q6:EntityMembers" />
120 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.3 HierarchyMembersGet
The HierarchyMembersGet operation retrieves all hierarchy members, the immediate children of a
specified hierarchy parent, or all descendants of a specified hierarchy parent.
This operation is optimized for hierarchy relationship retrieval and for walking the hierarchy path.
HierarchyMembersGet works within the context of a single hierarchy and a single version.
<wsdl:operation name="HierarchyMembersGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Hiera
rchyMembersGet" name="HierarchyMembersGetRequest" message="tns:HierarchyMembersGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Hiera
rchyMembersGetResponse" name="HierarchyMembersGetResponse"
message="tns:HierarchyMembersGetResponse" />
</wsdl:operation>
3.1.4.3.1 Messages
The following WSDL message definitions are specific to the HierarchyMembersGet operation.
3.1.4.3.1.1 HierarchyMembersGetRequest
3.1.4.3.1.2 HierarchyMembersGetResponse
3.1.4.3.2 Elements
The following XML schema element definitions are specific to the HierarchyMembersGet operation.
3.1.4.3.2.1 HierarchyMembersGetRequest
<xs:element name="HierarchyMembersGetRequest">
121 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.3.2.2 HierarchyMembersGetResponse
HierarchyData
OperationResult
<xs:element name="HierarchyMembersGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q9="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="HierarchyMembers" nillable="true" type="q9:HierarchyData" />
<xs:element xmlns:q10="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q10:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the HierarchyMembersGet
operation.
3.1.4.3.3.1 HierarchyMembersGetCriteria
The HierarchyMembersGetCriteria complex type specifies the hierarchy criteria for the result set
that is returned in HierarchyData.
The following is the XSD schema definition of the HierarchyMembersGetCriteria complex type.
<xs:complexType name="HierarchyMembersGetCriteria">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q560="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q560:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="Ancestors" type="xs:boolean" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true"
type="q560:Identifier">
<xs:annotation>
<xs:appinfo>
122 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Ancestors: Specifies an optional value that retrieves the ancestors of a member if set to "true".
MemberType: Specifies whether the type of members to return is consolidated member or leaf
member.
ParentEntityId: Specifies the GUID or the exact name of the parent member's entity. This value is
required for derived hierarchies only and is ignored for explicit hierarchies and collections.
RowLimit: Specifies the value to limit the number of child rows returned. This value defaults to the
system setting for HierarchyChildNodeLimit when it is not specified in the request. This value is
optional.
SearchTerm: Specifies a string to search for in member codes and in names. This value is optional.
123 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.3.3.2 HierarchyData
The HierarchyData complex type response is returned to describe a hierarchy and its members in
the result set that is returned in the response.
The following is the XSD schema definition of the HierarchyData complex type.
<xs:complexType name="HierarchyData">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q9="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContracts
" minOccurs="0" name="HierarchyType" type="q9:HierarchyType" />
<xs:element minOccurs="0" name="Members" nillable="true" type="tns:ArrayOfParentChild"
/>
<xs:element name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
EntityId: Specifies the Identifier for the entity that contains the GUID, name, and internal ID.
HierarchyId: Specifies the Identifier for the hierarchy that contains the GUID, name, and internal
ID.
HierarchyType: Specifies the HierarchyType that identifies the type of hierarchy construct.
Members: Specifies the ArrayOfParentChild that contains the hierarchy members and parent-child
relationships.
ModelId: Specifies the Identifier for the model that contains the GUID, name, and internal ID.
VersionId: Specifies the Identifier for the version that contains the GUID, name, and internal ID.
3.1.4.4 ModelMembersGet
The ModelMembersGet operation retrieves complete lists of entity members and/or hierarchies
from one or more models.
<wsdl:operation name="ModelMembersGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersGet" name="ModelMembersGetRequest" message="tns:ModelMembersGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersGetResponse" name="ModelMembersGetResponse" message="tns:ModelMembersGetResponse" />
</wsdl:operation>
124 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following WSDL message definitions are specific to the ModelMembersGet operation.
3.1.4.4.1.1 ModelMembersGetRequest
3.1.4.4.1.2 ModelMembersGetResponse
3.1.4.4.2 Elements
The following XML schema element definitions are specific to the ModelMembersGet operation.
3.1.4.4.2.1 ModelMembersGetRequest
The ModelMembersGetRequest element specifies the criteria for the retrieval of the model. The
Models and Versions parameters are required. The Entities parameter is optional. All entities are
returned if criteria are not specified.
<xs:element name="ModelMembersGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.4.2.2 ModelMembersGetResponse
The ModelMembersGetResponse element returns a response that contains one or more of the
following complex types:
ArrayOfEntityMembers
OperationResult
<xs:element name="ModelMembersGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q13="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelMembers" nillable="true" type="q13:ArrayOfEntityMembers" />
<xs:element xmlns:q14="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q14:OperationResult" />
</xs:sequence>
</xs:complexType>
125 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.5 EntityMembersCreate
<wsdl:operation name="EntityMembersCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersCreate" name="EntityMembersCreateRequest" message="tns:EntityMembersCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersCreateResponse" name="EntityMembersCreateResponse"
message="tns:EntityMembersCreateResponse" />
</wsdl:operation>
3.1.4.5.1 Messages
The following WSDL message definitions are specific to the EntityMembersCreate operation.
3.1.4.5.1.1 EntityMembersCreateRequest
3.1.4.5.1.2 EntityMembersCreateResponse
3.1.4.5.2 Elements
The following XML schema element definitions are specific to the EntityMembersCreate operation.
3.1.4.5.2.1 EntityMembersCreateRequest
<xs:element name="EntityMembersCreateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q15="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Members" nillable="true" type="q15:EntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
126 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.5.2.2 EntityMembersCreateResponse
<xs:element name="EntityMembersCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q16="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q16:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.6 EntityMembersDelete
The EntityMembersDelete operation deletes (deactivates) one or more members within an entity.
To undelete (reactivate) members, the Undelete option is set to "true" in the operation request.
<wsdl:operation name="EntityMembersDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersDelete" name="EntityMembersDeleteRequest" message="tns:EntityMembersDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersDeleteResponse" name="EntityMembersDeleteResponse"
message="tns:EntityMembersDeleteResponse" />
</wsdl:operation>
3.1.4.6.1 Messages
The following XSD schema message definitions are specific to the EntityMembersDeleteRequest
operation.
3.1.4.6.1.1 EntityMembersDeleteRequest
3.1.4.6.1.2 EntityMembersDeleteResponse
127 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema element definitions are specific to the EntityMembersDelete operation.
3.1.4.6.2.1 EntityMembersDeleteRequest
<xs:element name="EntityMembersDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q17="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Members" nillable="true" type="q17:EntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.6.2.2 EntityMembersDeleteResponse
<xs:element name="EntityMembersDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q18="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q18:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.7 EntityMembersUpdate
The EntityMembersUpdate operation updates one or more existing members within an entity.
Members are matched by model, version, entity, and member code.
EntityMembersUpdate can move members in a hierarchy based on parents or siblings. Note that
the parent domain controller contains a relationship type that can be a parent or sibling.
<wsdl:operation name="EntityMembersUpdate">
128 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.7.1 Messages
The following WSDL message definitions are specific to the EntityMembersUpdate operation.
3.1.4.7.1.1 EntityMembersUpdateRequest
3.1.4.7.1.2 EntityMembersUpdateResponse
3.1.4.7.2 Elements
The following XML schema element definitions are specific to the EntityMembersUpdate operation.
3.1.4.7.2.1 EntityMembersUpdateRequest
<xs:element name="EntityMembersUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q19="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Members" nillable="true" type="q19:EntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.7.2.2 EntityMembersUpdateResponse
129 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.8 EntityMembersCopy
The EntityMembersCopy operation copies members and their associated data (for example,
attributes and hierarchy parents) to new members with new member codes.
A members list is used for input. This list includes source and target member codes. Each item in
the list includes a source (code of an existing member) and a target (code of a new member).
Source members are matched by model, version, entity, and member code. GUIDs and/or exact
names are used to identify metadata component context.
Each source member that is not found results in an error. Each target code that already exists within
the entity and version results in an error. This occurs because codes MUST be unique. All listed
members are attempted regardless of individual record errors. The output includes a list of the
members that were successfully copied.
To use this operation, users MUST have permission to create new members and to update the
source members. For general information about members, see section 3.1.4.7. Any attributes and
hierarchy parents that are associated with the source member for which update permission is
granted are assigned to the target member.
Any hierarchy member permission assignments that are directly attached to source members (not
inherited) are copied to target members.
<wsdl:operation name="EntityMembersCopy">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersCopy" name="EntityMembersCopyRequest" message="tns:EntityMembersCopyRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersCopyResponse" name="EntityMembersCopyResponse"
message="tns:EntityMembersCopyResponse" />
</wsdl:operation>
3.1.4.8.1 Messages
The following WSDL message definitions are specific to the EntityMembersCopy operation.
3.1.4.8.1.1 EntityMembersCopyRequest
130 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.8.2 Elements
The following XML schema element definitions are specific to the EntityMembersCopy operation.
3.1.4.8.2.1 EntityMembersCopyRequest
<xs:element name="EntityMembersCopyRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q21="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityMembersCopyCriteria" nillable="true" type="q21:MembersCopyCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.8.2.2 EntityMembersCopyResponse
<xs:element name="EntityMembersCopyResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q22="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q22:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the EntityMembersCopy
operation.
3.1.4.8.3.1 MembersCopyCriteria
The MembersCopyCriteria request complex type specifies the member criteria for the copy
operations.
131 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:complexType name="MembersCopyCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="Members" nillable="true"
type="tns:ArrayOfMemberSourceTarget" />
<xs:element name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element name="VersionId" nillable="true" type="tns:Identifier" />
<xs:element name="EntityId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
Members: Specifies the ArrayOfMemberSourceTarget complex type that contains the members to
be copied.
ModelID: Specifies the GUID or the exact name of the model in the Identifier complex type.
VersionID: Specifies the GUID or the exact name of the version in the Identifier complex type.
EntityID: Specifies the GUID or the exact name of the entity in the Identifier complex type.
3.1.4.8.3.2 ArrayOfMemberSourceTarget
The following is the XSD schema definition of the ArrayOfMemberSourceTarget complex type.
<xs:complexType name="ArrayOfMemberSourceTarget">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="MemberSourceTarget"
nillable="true" type="tns:MemberSourceTarget" />
</xs:sequence>
</xs:complexType>
3.1.4.8.3.3 MemberSourceTarget
The MemberSourceTarget complex type contains the member codes of the source and target
members to be copied.
The following is the XSD schema definition of the MemberSourceTarget complex type.
<xs:complexType name="MemberSourceTarget">
<xs:sequence>
<xs:element minOccurs="0" name="SourceMemberCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="TargetMemberCode" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
132 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
TargetMemberCode: Specifies the member code of the new target member to be created by the
copy operation.
3.1.4.9 EntityMembersMerge
The EntityMembersMerge operation creates and/or updates members without regard to whether
the member already exists.
If the member already exists (matched by context and member code), a member update is
performed. If the member does not already exist, it is created. EntityMembersMerge is otherwise
similar to EntityMembersCreate when creating members and EntityMembersUpdate when updating
members.
<wsdl:operation name="EntityMembersMerge">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersMerge" name="EntityMembersMergeRequest" message="tns:EntityMembersMergeRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMembersMergeResponse" name="EntityMembersMergeResponse"
message="tns:EntityMembersMergeResponse" />
</wsdl:operation>
3.1.4.9.1 Messages
The following WSDL message definitions are specific to the EntityMembersMerge operation.
3.1.4.9.1.1 EntityMembersMergeRequest
3.1.4.9.1.2 EntityMembersMergeResponse
3.1.4.9.2 Elements
The following XML schema element definitions are specific to the EntityMembersMerge operation.
3.1.4.9.2.1 EntityMembersMergeRequest
<xs:element name="EntityMembersMergeRequest">
133 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.9.2.2 EntityMembersMergeResponse
<xs:element name="EntityMembersMergeResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q24="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q24:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.10 ModelMembersBulkDelete
The operation returns the batch IDs for the staging records, not the results of the deletion.
<wsdl:operation name="ModelMembersBulkDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersBulkDelete" name="ModelMembersBulkDeleteRequest"
message="tns:ModelMembersBulkDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersBulkDeleteResponse" name="ModelMembersBulkDeleteResponse"
message="tns:ModelMembersBulkDeleteResponse" />
</wsdl:operation>
134 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following WSDL message definitions are specific to the ModelMembersBulkDelete operation.
3.1.4.10.1.1 ModelMembersBulkDeleteRequest
3.1.4.10.1.2 ModelMembersBulkDeleteResponse
3.1.4.10.2 Elements
The following XML schema element definitions are specific to the ModelMembersBulkDelete
operation.
3.1.4.10.2.1 ModelMembersBulkDeleteRequest
<xs:element name="ModelMembersBulkDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q25="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="1"
name="ModelMembers" nillable="true" type="q25:ArrayOfEntityMembers" />
<xs:element minOccurs="1" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.10.2.2 ModelMembersBulkDeleteResponse
<xs:element name="ModelMembersBulkDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q26="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="1"
name="OperationResult" nillable="true" type="q26:OperationResult" />
<xs:element xmlns:q27="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="1"
name="StagingBatches" nillable="true" type="q27:ArrayOfIdentifier" />
</xs:sequence>
</xs:complexType>
135 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.11 ModelMembersBulkUpdate
This operation is similar to EntityMembersUpdate and has the same input/request format.
All data changes are translated into staging batch records (attribute and relationship staging
only).
The operation returns the batch ID for the staging records, not the results of the update.
<wsdl:operation name="ModelMembersBulkUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersBulkUpdate" name="ModelMembersBulkUpdateRequest"
message="tns:ModelMembersBulkUpdateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersBulkUpdateResponse" name="ModelMembersBulkUpdateResponse"
message="tns:ModelMembersBulkUpdateResponse" />
</wsdl:operation>
3.1.4.11.1 Messages
The following WSDL message definitions are specific to the ModelMembersBulkUpdate operation.
3.1.4.11.1.1 ModelMembersBulkUpdateRequest
3.1.4.11.1.2 ModelMembersBulkUpdateResponse
3.1.4.11.2 Elements
The following XML schema element definitions are specific to the ModelMembersBulkUpdate
operation.
3.1.4.11.2.1 ModelMembersBulkUpdateRequest
136 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="ModelMembersBulkUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q28="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelMembers" nillable="true" type="q28:ArrayOfEntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.11.2.2 ModelMembersBulkUpdateResponse
<xs:element name="ModelMembersBulkUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q29="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q29:OperationResult" />
<xs:element xmlns:q30="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="StagingBatches" nillable="true" type="q30:ArrayOfIdentifier" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.12 ModelMembersBulkMerge
All data changes are translated into staging batch records, including member Create operations.
The operation returns the batch IDs for the staging records, not the results of the Create or
Update operation.
<wsdl:operation name="ModelMembersBulkMerge">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Model
MembersBulkMerge" name="ModelMembersBulkMergeRequest"
message="tns:ModelMembersBulkMergeRequest" />
137 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.12.1 Messages
The following WSDL message definitions are specific to the ModelMembersBulkMerge operation.
3.1.4.12.1.1 ModelMembersBulkMergeRequest
3.1.4.12.1.2 ModelMembersBulkMergeResponse
3.1.4.12.2 Elements
The following XML schema element definitions are specific to the ModelMembersBulkMerge
operation.
3.1.4.12.2.1 ModelMembersBulkMergeRequest
<xs:element name="ModelMembersBulkMergeRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q31="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelMembers" nillable="true" type="q31:ArrayOfEntityMembers" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.12.2.2 ModelMembersBulkMergeResponse
<xs:element name="ModelMembersBulkMergeResponse">
<xs:complexType>
138 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.13 StagingGet
The StagingGet operation retrieves a staging record set by using batch IDs. This operation can be
used to retrieve the following:
Information about the batch and the data that is contained in the batch.
<wsdl:operation name="StagingGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngGet" name="StagingGetRequest" message="tns:StagingGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngGetResponse" name="StagingGetResponse" message="tns:StagingGetResponse" />
</wsdl:operation>
3.1.4.13.1 Messages
The following XSD schema message definitions are specific to the StagingGet operation.
3.1.4.13.1.1 StagingGetRequest
3.1.4.13.1.2 StagingGetResponse
3.1.4.13.2 Elements
The following XML schema element definitions are specific to the StagingGet operation.
3.1.4.13.2.1 StagingGetRequest
The StagingGetRequest element specifies the criteria in the StagingResultCriteria complex type for
the retrieval of staging information.
139 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.13.2.2 StagingGetResponse
The StagingGetResponse element returns a response that contains an operation result and an
ArrayOfStagingBatch instance that contains staging batch information.
<xs:element name="StagingGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q36="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Batches" nillable="true" type="q36:ArrayOfStagingBatch" />
<xs:element xmlns:q37="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q37:OperationResult" />
<xs:element xmlns:q38="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="UnbatchedInformation" nillable="true" type="q38:ArrayOfStagingUnbatchedInformation" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the StagingGet operation.
3.1.4.13.3.1 StagingResultCriteria
The StagingResultCriteria request complex type specifies the criteria for staging batch categories.
The following is the XSD schema definition of the StagingResultCriteria complex type.
<xs:complexType name="StagingResultCriteria">
<xs:complexContent mixed="false">
<xs:extension
xmlns:q466="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09"
base="q466:DataContractBase">
<xs:sequence>
<xs:element minOccurs="0" name="All" type="xs:boolean">
<xs:annotation>
<xs:appinfo>
<DefaultValue EmitDefaultValue="false"
xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
140 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.13.3.2 StagingSearchCriteria
The StagingSearchCriteria request complex type specifies the criteria for staging batch types.
The following is the XSD schema definition of the StagingSearchCriteria complex type.
<xs:complexType name="StagingSearchCriteria">
141 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
StagingBatchStatus: Specifies the staging batch status that indicates the processing status of a
staging batch.
StagingBatches: Specifies an ArrayOfIdentifier instance that contains the staging batch identifiers.
StagingDataStatus: Specifies the staging data status that indicates the success or failure of
staging records.
3.1.4.14 StagingClear
The StagingClear operation removes records from an existing staging batch. This operation is
asynchronous. The request to clear a batch is queued up for processing along with all other batch
requests. This process prevents batches that are in process from being cleared.
<wsdl:operation name="StagingClear">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngClear" name="StagingClearRequest" message="tns:StagingClearRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngClearResponse" name="StagingClearResponse" message="tns:StagingClearResponse" />
</wsdl:operation>
3.1.4.14.1 Messages
The following WSDL message definitions are specific to the StagingClear operation.
3.1.4.14.1.1 StagingClearRequest
3.1.4.14.1.2 StagingClearResponse
3.1.4.14.2 Elements
The following XML schema element definitions are specific to the StagingClear operation.
142 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="StagingClearRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q39="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Batches" nillable="true" type="q39:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.14.2.2 StagingClearResponse
The StagingClearResponse element specifies counts for the batches and the attribute, member,
and relationship records that are cleared.
<xs:element name="StagingClearResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="AttributesRecordsClearedCount" type="xs:int" />
<xs:element minOccurs="0" name="BatchesClearedCount" type="xs:int" />
<xs:element minOccurs="0" name="MemberRecordsClearedCount" type="xs:int" />
<xs:element xmlns:q40="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q40:OperationResult" />
<xs:element minOccurs="0" name="RelationshipRecordsClearedCount" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.15 TransactionsGet
The TransactionsGet operation retrieves all transactions for a model version or queries specific
transactions by using specified criteria.
<wsdl:operation name="TransactionsGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionsGet" name="TransactionsGetRequest" message="tns:TransactionsGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionsGetResponse" name="TransactionsGetResponse" message="tns:TransactionsGetResponse" />
</wsdl:operation>
143 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XSD schema message definitions are specific to the TransactionsGet operation.
3.1.4.15.1.1 TransactionsGetRequest
3.1.4.15.1.2 TransactionsGetResponse
3.1.4.15.2 Elements
The following XML schema element definitions are specific to the TransactionsGet operation.
3.1.4.15.2.1 TransactionsGetRequest
<xs:element name="TransactionsGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q41="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="TransactionSearchCriteria" nillable="true" type="q41:TransactionSearchCriteria" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.15.2.2 TransactionsGetResponse
<xs:element name="TransactionsGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q42="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q42:OperationResult" />
<xs:element minOccurs="0" name="TotalRecordCount" type="xs:int" />
<xs:element xmlns:q43="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="TransactionList" nillable="true" type="q43:ArrayOfTransaction" />
</xs:sequence>
</xs:complexType>
</xs:element>
144 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema complex type definitions are specific to the TransactionsGet operation.
3.1.4.15.3.1 TransactionSearchCriteria
The TransactionSearchCriteria request complex type specifies the Transaction criteria for the
operations result set.
The following is the XSD schema definition of the TransactionSearchCriteria complex type.
<xs:complexType name="TransactionSearchCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="DateTimeBeginRange" nillable="true" type="xs:dateTime"
/>
<xs:element minOccurs="0" name="DateTimeEndRange" nillable="true" type="xs:dateTime" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ExplicitHierarchyId" nillable="true"
type="tns:Identifier" />
<xs:element minOccurs="0" name="MemberId" nillable="true" type="tns:MemberIdentifier"
/>
<xs:element minOccurs="0" name="MemberType" nillable="true" type="tns:MemberType" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="NewValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="PageNumber" type="xs:int" />
<xs:element minOccurs="0" name="PageSize" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="PriorValue" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="SortColumn" nillable="true" type="xs:string" />
<xs:element
xmlns:q16="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="SortDirection" nillable="true" type="q16:SortDirection" />
<xs:element minOccurs="0" name="TransactionId" nillable="true" type="xs:int" />
<xs:element
xmlns:q17="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="TransactionType" nillable="true" type="q17:TransactionType" />
<xs:element minOccurs="0" name="UserId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="VersionId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
EntityId: Specifies the GUID or the name of an entity to further restrict output.
ModelId: Specifies the TransactionsGet operation to retrieve all transactions for a model version or
to query specific transactions by using specified criteria.
145 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.16 TransactionsReverse
The TransactionsReverse operation reverses one or more transactions, in the order specified.
When a transaction is reversed, it is set to its prior value. The transactions to reverse are specified
by their transaction ID. Transactions and their IDs are retrieved by using TransactionsGet.
<wsdl:operation name="TransactionsReverse">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionsReverse" name="TransactionsReverseRequest" message="tns:TransactionsReverseRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionsReverseResponse" name="TransactionsReverseResponse"
message="tns:TransactionsReverseResponse" />
</wsdl:operation>
3.1.4.16.1 Messages
The following WSDL message definitions are specific to the TransactionsReverse operation.
3.1.4.16.1.1 TransactionsReverseRequest
3.1.4.16.1.2 TransactionsReverseResponse
3.1.4.16.2 Elements
The following XML schema element definitions are specific to the TransactionsReverse operation.
146 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="TransactionsReverseRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q44="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
minOccurs="0" name="Transactions" nillable="true" type="q44:ArrayOfint" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.16.2.2 TransactionsReverseResponse
<xs:element name="TransactionsReverseResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q45="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q45:OperationResult" />
<xs:element xmlns:q46="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="TransactionsReversed" nillable="true" type="q46:ArrayOfReplacementId" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the TransactionsReverse
operation.
3.1.4.16.3.1 ArrayOfReplacementId
The ArrayOfReplacementId response complex type contains the array of transaction IDs that
were replaced during the replacement operation.
The following is the XSD schema definition of the ArrayOfReplacementId complex type.
<xs:complexType name="ArrayOfReplacementId">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ReplacementId" nillable="true"
type="tns:ReplacementId" />
147 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ReplacementId: Specifies the instance of the ReplacementId complex type that provides
information about a reversed transaction.
3.1.4.16.3.2 ReplacementId
The ReplacementId response complex type specifies an individual transaction that was replaced
during the replacement operation, including prior and new identifiers.
The following is the XSD schema definition of the ReplacementId complex type.
<xs:complexType name="ReplacementId">
<xs:sequence>
<xs:element minOccurs="0" name="NewId" type="xs:int" />
<xs:element minOccurs="0" name="PriorId" type="xs:int" />
</xs:sequence>
</xs:complexType>
3.1.4.17 ValidationGet
The ValidationGet operation retrieves validation issues for an entire model version's members or
selected members by using specified criteria.
<wsdl:operation name="ValidationGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Valid
ationGet" name="ValidationGetRequest" message="tns:ValidationGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Valid
ationGetResponse" name="ValidationGetResponse" message="tns:ValidationGetResponse" />
</wsdl:operation>
3.1.4.17.1 Messages
The following WSDL message definitions are specific to the ValidationGet operation.
3.1.4.17.1.1 ValidationGetRequest
3.1.4.17.1.2 ValidationGetResponse
148 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema element definitions are specific to the ValidationGet operation.
3.1.4.17.2.1 ValidationGetRequest
<xs:element name="ValidationGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q47="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ValidationSearchCriteria" nillable="true" type="q47:ValidationSearchCriteria" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.17.2.2 ValidationGetResponse
The ValidationGetResponse element holds the response values for the ValidationGetRequest.
<xs:element name="ValidationGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="IsRunning" type="xs:boolean" />
<xs:element xmlns:q48="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q48:OperationResult" />
<xs:element xmlns:q49="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="SummaryItems" nillable="true" type="q49:ArrayOfValidationSummaryItem" />
<xs:element xmlns:q50="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ValidationIssueList" nillable="true" type="q50:ArrayOfValidationIssue" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the ValidationGet operation.
3.1.4.17.3.1 ValidationSearchCriteria
The ValidationSearchCriteria complex type specifies the search criteria for ValidationGetRequest.
The following is the XSD schema definition of the ValidationSearchCriteria complex type.
<xs:complexType name="ValidationSearchCriteria">
149 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
EntityId: Specifies the GUID or the name of an entity to further restrict output.
Members: Specifies member codes (in combination with Entity) to retrieve transactions for one or
more specific members.
UserId: Specifies the user. Issues are assigned to all users who can correct them.
3.1.4.17.3.2 ArrayOfValidationSummaryItem
The following is the XSD schema definition of the ArrayOfValidationSummaryItem complex type.
<xs:complexType name="ArrayOfValidationSummaryItem">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ValidationSummaryItem"
nillable="true" type="tns:ValidationSummaryItem" />
</xs:sequence>
</xs:complexType>
3.1.4.17.3.3 ValidationSummaryItem
The following is the XSD schema definition of the ValidationSummaryItem complex type.
<xs:complexType name="ValidationSummaryItem">
<xs:sequence>
<xs:element minOccurs="0" name="MemberCount" type="xs:int" />
<xs:element
xmlns:q19="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Status" type="q19:ValidationStatus" />
</xs:sequence>
150 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Status: Specifies the status of the validation process at any given moment during the validation
process.
3.1.4.18 ValidationProcess
The ValidationProcess operation is used to process validations (business rules) for selected
members within a model.
<wsdl:operation name="ValidationProcess">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Valid
ationProcess" name="ValidationProcessRequest" message="tns:ValidationProcessRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Valid
ationProcessResponse" name="ValidationProcessResponse"
message="tns:ValidationProcessResponse" />
</wsdl:operation>
3.1.4.18.1 Messages
The following WSDL message definitions are specific to the ValidationProcess operation.
3.1.4.18.1.1 ValidationProcessRequest
3.1.4.18.1.2 ValidationProcessResponse
3.1.4.18.2 Elements
The following XML schema element definitions are specific to the ValidationProcess operation.
3.1.4.18.2.1 ValidationProcessRequest
The ValidationProcessRequest element specifies the validation process criteria and options.
<xs:element name="ValidationProcessRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q51="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ValidationProcessCriteria" nillable="true" type="q51:ValidationProcessCriteria" />
151 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.18.2.2 ValidationProcessResponse
The ValidationProcessResponse element holds the response values back from the validation
process.
<xs:element name="ValidationProcessResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q53="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q53:OperationResult" />
<xs:element xmlns:q54="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ValidationIssueList" nillable="true" type="q54:ArrayOfValidationIssue" />
<xs:element xmlns:q55="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ValidationProcessResult" nillable="true" type="q55:ValidationProcessResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the ValidationProcess
operation.
3.1.4.18.3.1 ValidationProcessCriteria
The following is the XSD schema definition of the ValidationProcessCriteria complex type.
<xs:complexType name="ValidationProcessCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
152 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
EntityId: Specifies the GUID or the name of an entity to further restrict output.
Members: Specifies member codes (together with Entity) to retrieve transactions for one or more
specific members.
3.1.4.18.3.2 ValidationProcessOptions
The ValidationProcessOptions complex type specifies the following validation process options:
The following is the XSD schema definition of the ValidationProcessOptions complex type.
<xs:complexType name="ValidationProcessOptions">
<xs:sequence>
<xs:element minOccurs="0" name="CommitVersion" type="xs:boolean" />
<xs:element minOccurs="0" name="ReturnValidationResults" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
CommitVersion: Specifies whether the version being validated is committed after validation.
ReturnValidationResults: Specifies whether the validation results are returned after validation.
3.1.4.18.3.3 ValidationProcessResult
The following is the XSD schema definition of the ValidationProcessResult complex type.
<xs:complexType name="ValidationProcessResult">
<xs:sequence>
<xs:element minOccurs="0" name="MembersInvalidCount" type="xs:int" />
<xs:element minOccurs="0" name="MembersValidCount" type="xs:int" />
<xs:element minOccurs="0" name="MembersValidatedCount" type="xs:int" />
</xs:sequence>
</xs:complexType>
MembersInvalidCount: Specifies the number of members that are found to be invalid during
validation.
153 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MembersValidatedCount: Specifies the number of members that are validated as part of the
validation process.
3.1.4.19 EntityMemberAnnotationsCreate
Model ID
Version ID
Entity ID
Member ID
<wsdl:operation name="EntityMemberAnnotationsCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAnnotationsCreate" name="EntityMemberAnnotationsCreateRequest"
message="tns:EntityMemberAnnotationsCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAnnotationsCreateResponse" name="AnnotationsCreateResponse"
message="tns:AnnotationsCreateResponse" />
</wsdl:operation>
3.1.4.19.1 Messages
3.1.4.19.1.1 EntityMemberAnnotationsCreateRequest
3.1.4.19.1.2 AnnotationsCreateResponse
3.1.4.19.2 Elements
154 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="EntityMemberAnnotationsCreateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q56="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Annotations" nillable="true" type="q56:ArrayOfAnnotation" />
<xs:element xmlns:q57="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityId" nillable="true" type="q57:Identifier" />
<xs:element xmlns:q58="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="MemberId" nillable="true" type="q58:MemberIdentifier" />
<xs:element xmlns:q59="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelId" nillable="true" type="q59:Identifier" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q60="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="VersionId" nillable="true" type="q60:Identifier" />
</xs:sequence>
</xs:complexType>
</xs:element>
VersionId: Specifies the GUID or the exact name of the model version.
3.1.4.19.2.2 AnnotationsCreateResponse
<xs:element name="AnnotationsCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q61="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q61:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
155 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.20 TransactionAnnotationsCreate
A user can annotate only his or her own transactions. Model administrators can annotate all
transactions.
This operation requires a single transaction ID input together with one or more annotation
comments.
<wsdl:operation name="TransactionAnnotationsCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionAnnotationsCreate" name="TransactionAnnotationsCreateRequest"
message="tns:TransactionAnnotationsCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionAnnotationsCreateResponse" name="AnnotationsCreateResponse"
message="tns:AnnotationsCreateResponse" />
</wsdl:operation>
3.1.4.20.1 Messages
3.1.4.20.1.1 TransactionAnnotationsCreateRequest
3.1.4.20.2 Elements
The following XML schema element definitions are specific to the TransactionAnnotationsCreate
operation.
3.1.4.20.2.1 TransactionAnnotationsCreateRequest
<xs:element name="TransactionAnnotationsCreateRequest">
<xs:complexType>
156 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.21 EntityMemberAnnotationsGet
Model ID
Version ID
Entity ID
Member ID
<wsdl:operation name="EntityMemberAnnotationsGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAnnotationsGet" name="EntityMemberAnnotationsGetRequest"
message="tns:EntityMemberAnnotationsGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberAnnotationsGetResponse" name="EntityMemberAnnotationsGetResponse"
message="tns:EntityMemberAnnotationsGetResponse" />
</wsdl:operation>
3.1.4.21.1 Messages
3.1.4.21.1.1 EntityMemberAnnotationsGetRequest
157 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.21.2 Elements
The following XML schema element definitions are specific to the EntityMemberAnnotationsGet
operation.
3.1.4.21.2.1 EntityMemberAnnotationsGetRequest
<xs:element name="EntityMemberAnnotationsGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q63="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityId" nillable="true" type="q63:Identifier" />
<xs:element xmlns:q64="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="MemberId" nillable="true" type="q64:MemberIdentifier" />
<xs:element xmlns:q65="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelId" nillable="true" type="q65:Identifier" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q66="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="VersionId" nillable="true" type="q66:Identifier" />
</xs:sequence>
</xs:complexType>
</xs:element>
MemberId: Specifies the MemberIdentifier of the member whose annotations are requested.
3.1.4.21.2.2 EntityMemberAnnotationsGetResponse
<xs:element name="EntityMemberAnnotationsGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q67="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityId" nillable="true" type="q67:Identifier" />
158 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
MemberId: Specifies the MemberIdentifier of the member whose annotations were retrieved.
3.1.4.22 TransactionAnnotationsGet
<wsdl:operation name="TransactionAnnotationsGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionAnnotationsGet" name="TransactionAnnotationsGetRequest"
message="tns:TransactionAnnotationsGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Trans
actionAnnotationsGetResponse" name="TransactionAnnotationsGetResponse"
message="tns:TransactionAnnotationsGetResponse" />
</wsdl:operation>
3.1.4.22.1 Messages
The following WSDL message definitions are specific to the TransactionAnnotationsGet operation.
3.1.4.22.1.1 TransactionAnnotationsGetRequest
3.1.4.22.1.2 TransactionAnnotationsGetResponse
159 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema element definitions are specific to the TransactionAnnotationsGet
operation.
3.1.4.22.2.1 TransactionAnnotationsGetRequest
<xs:element name="TransactionAnnotationsGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element minOccurs="0" name="TransactionId" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.22.2.2 TransactionAnnotationsGetResponse
<xs:element name="TransactionAnnotationsGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q72="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Annotations" nillable="true" type="q72:ArrayOfAnnotation" />
<xs:element xmlns:q73="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q73:OperationResult" />
<xs:element minOccurs="0" name="TransactionId" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
Annotations: Specifies a collection of annotations that are returned by using the ArrayOfAnnotation
complex type.
3.1.4.23 AnnotationsUpdate
The AnnotationsUpdate operation updates the comment text of an existing annotation. Only the
user who created the annotation or a model administrator can update an annotation. The
160 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="AnnotationsUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Annot
ationsUpdate" name="AnnotationsUpdateRequest" message="tns:AnnotationsUpdateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Annot
ationsUpdateResponse" name="AnnotationsUpdateResponse"
message="tns:AnnotationsUpdateResponse" />
</wsdl:operation>
3.1.4.23.1 Messages
The following WSDL message definitions are specific to the AnnotationsUpdate operation.
3.1.4.23.1.1 AnnotationsUpdateRequest
3.1.4.23.1.2 AnnotationsUpdateResponse
3.1.4.23.2 Elements
The following XML schema element definitions are specific to the AnnotationsUpdate operation.
3.1.4.23.2.1 AnnotationsUpdateRequest
The AnnotationsUpdateRequest element specifies the details of the annotations update request.
<xs:element name="AnnotationsUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="Comment" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="Id" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
161 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="AnnotationsUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q74="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q74:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.24 AnnotationsDelete
The AnnotationsDelete operation deletes an existing annotation by annotation ID. Only the user
who created the annotation or a model administrator can delete an annotation. The annotations are
found by ID.
<wsdl:operation name="AnnotationsDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Annot
ationsDelete" name="AnnotationsDeleteRequest" message="tns:AnnotationsDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Annot
ationsDeleteResponse" name="AnnotationsDeleteResponse"
message="tns:AnnotationsDeleteResponse" />
</wsdl:operation>
3.1.4.24.1 Messages
The following WSDL message definitions are specific to the AnnotationsDelete operation.
3.1.4.24.1.1 AnnotationsDeleteRequest
3.1.4.24.1.2 AnnotationsDeleteResponse
3.1.4.24.2 Elements
The following XML schema element definitions are specific to the AnnotationsDelete operation.
162 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="AnnotationsDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="Id" type="xs:int" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.24.2.2 AnnotationsDeleteResponse
<xs:element name="AnnotationsDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q75="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q75:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.25 EntityMemberKeyLookup
<wsdl:operation name="EntityMemberKeyLookup">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberKeyLookup" name="EntityMemberKeyGetRequest" message="tns:EntityMemberKeyGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Entit
yMemberKeyLookupResponse" name="EntityMemberKeyGetResponse"
message="tns:EntityMemberKeyGetResponse" />
</wsdl:operation>
163 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following WSDL message definitions are specific to the EntityMemberKeyLookup operation.
3.1.4.25.1.1 EntityMemberKeyGetRequest
3.1.4.25.1.2 EntityMemberKeyGetResponse
3.1.4.25.2 Elements
The following XML schema element definitions are specific to the EntityMemberKeyLookup
operation.
3.1.4.25.2.1 EntityMemberKeyGetRequest
<xs:element name="EntityMemberKeyGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q76="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="EntityId" nillable="true" type="q76:Identifier" />
<xs:element
xmlns:q77="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="LookupType" type="q77:MemberKeyLookupType" />
<xs:element xmlns:q78="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="MemberKeys" nillable="true" type="q78:ArrayOfMemberKey" />
<xs:element xmlns:q79="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="MemberType" type="q79:MemberType" />
<xs:element xmlns:q80="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ModelId" nillable="true" type="q80:Identifier" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q81="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="VersionId" nillable="true" type="q81:Identifier" />
</xs:sequence>
</xs:complexType>
</xs:element>
LookupType: Specifies the lookup type by using the MemberKeyLookupType simple type.
MemberKeys: Specifies a collection of member keys, either code or internal ID, by using the
ArrayOfMemberKey complex type.
164 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
VersionId: Specifies the GUID or the exact name of the model version.
3.1.4.25.2.2 EntityMemberKeyGetResponse
<xs:element name="EntityMemberKeyGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q82="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="MemberKeys" nillable="true" type="q82:ArrayOfMemberKey" />
<xs:element xmlns:q83="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q83:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
MemberKeys: Specifies a collection of member keys that contain member codes (if the internal ID
is provided) or the internal ID (if member codes are provided) by using the ArrayOfMemberKey
complex type.
The following XML schema complex type definitions are specific to the EntityMemberKeyLookup
operation.
3.1.4.25.3.1 MemberKey
The MemberKey complex type holds the member code, the internal ID, or both for a member.
The following is the XSD schema definition of the MemberKey complex type.
<xs:complexType name="MemberKey">
<xs:sequence>
<xs:element minOccurs="0" name="MemberCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="MemberId" type="xs:int" />
</xs:sequence>
</xs:complexType>
3.1.4.25.3.2 ArrayOfMemberKey
165 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:complexType name="ArrayOfMemberKey">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="MemberKey" nillable="true"
type="tns:MemberKey" />
</xs:sequence>
</xs:complexType>
MemberKey: Specifies the member code and/or internal ID as specified by the MemberKey
complex type.
3.1.4.26 StagingProcess
The StagingProcess operation sweeps existing unbatched records in the staging tables into a batch
for processing and launches execution of the staging queue on request. This operation can be used
to retrieve the following:
Information about the batch and the data that is contained in the batch.
<wsdl:operation name="StagingProcess">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngProcess" name="StagingProcessRequest" message="tns:StagingProcessRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Stagi
ngProcessResponse" name="StagingProcessResponse" message="tns:StagingProcessResponse" />
</wsdl:operation>
3.1.4.26.1 Messages
The following WSDL message definitions are specific to the StagingProcess operation.
3.1.4.26.1.1 StagingProcessRequest
3.1.4.26.1.2 StagingProcessResponse
3.1.4.26.2 Elements
The following XML schema element definitions are specific to the StagingProcess operation.
3.1.4.26.2.1 StagingProcessRequest
The StagingProcessRequest element specifies the details of the staging process request.
166 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="StagingProcessRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="Process" type="xs:boolean" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q84="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="UnbatchedCriteria" nillable="true" type="q84:StagingUnbatchedCriteria" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.26.2.2 StagingProcessResponse
The StagingProcessResponse element holds the details of the staging process response.
<xs:element name="StagingProcessResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q85="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="BatchId" nillable="true" type="q85:StagingBatch" />
<xs:element xmlns:q86="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q86:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the StagingProcess operation.
3.1.4.26.3.1 StagingUnbatchedCriteria
The following is the XSD schema definition of the StagingUnbatchedCriteria complex type.
<xs:complexType name="StagingUnbatchedCriteria">
167 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
SourceSystemId: Specifies the GUID or the exact name of the source system.
3.1.4.27 ExportViewCreate
<wsdl:operation name="ExportViewCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewCreate" name="ExportViewCreateRequest" message="tns:ExportViewCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewCreateResponse" name="ExportViewCreateResponse" message="tns:ExportViewCreateResponse"
/>
</wsdl:operation>
3.1.4.27.1 Messages
The following WSDL message definitions are specific to the ExportViewCreate operation.
3.1.4.27.1.1 ExportViewCreateRequest
3.1.4.27.1.2 ExportViewCreateResponse
3.1.4.27.2 Elements
The following XML schema element definitions are specific to the ExportViewCreate operation.
3.1.4.27.2.1 ExportViewCreateRequest
168 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ExportView: Specifies the export view by using the ExportView complex type.
3.1.4.27.2.2 ExportViewCreateResponse
<xs:element name="ExportViewCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q88="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q88:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.28 ExportViewUpdate
<wsdl:operation name="ExportViewUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewUpdate" name="ExportViewUpdateRequest" message="tns:ExportViewUpdateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewUpdateResponse" name="ExportViewUpdateResponse" message="tns:ExportViewUpdateResponse"
/>
</wsdl:operation>
3.1.4.28.1 Messages
The following WSDL message definitions are specific to the ExportViewUpdate operation.
169 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.28.1.2 ExportViewUpdateResponse
3.1.4.28.2 Elements
The following XML schema element definitions are specific to the ExportViewUpdate operation.
3.1.4.28.2.1 ExportViewUpdateRequest
The ExportViewUpdateRequest element specifies the details of the export view update request.
<xs:element name="ExportViewUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q89="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ExportView" nillable="true" type="q89:ExportView" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
ExportView: Specifies the export view by using the ExportView complex type.
3.1.4.28.2.2 ExportViewUpdateResponse
<xs:element name="ExportViewUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q90="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q90:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.29 ExportViewDelete
The ExportViewDelete operation removes an existing export view from the master data database.
170 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="ExportViewDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewDelete" name="ExportViewDeleteRequest" message="tns:ExportViewDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewDeleteResponse" name="ExportViewDeleteResponse" message="tns:ExportViewDeleteResponse"
/>
</wsdl:operation>
3.1.4.29.1 Messages
The following WSDL message definitions are specific to the ExportViewDelete operation.
3.1.4.29.1.1 ExportViewDeleteRequest
3.1.4.29.1.2 ExportViewDeleteResponse
3.1.4.29.2 Elements
The following XML schema element definitions are specific to the ExportViewDelete operation.
3.1.4.29.2.1 ExportViewDeleteRequest
The ExportViewDeleteRequest element specifies the details of the export view delete request.
<xs:element name="ExportViewDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q91="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Identifier" nillable="true" type="q91:Identifier" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
Identifier: Specifies the internal identifier for the export view to delete.
3.1.4.29.2.2 ExportViewDeleteResponse
171 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="ExportViewDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q92="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q92:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.30 ExportViewListGet
<wsdl:operation name="ExportViewListGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewListGet" name="ExportViewListGetRequest" message="tns:ExportViewListGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Expor
tViewListGetResponse" name="ExportViewListGetResponse"
message="tns:ExportViewListGetResponse" />
</wsdl:operation>
3.1.4.30.1 Messages
The following WSDL message definitions are specific to the ExportViewListGet operation.
3.1.4.30.1.1 ExportViewListGetRequest
3.1.4.30.1.2 ExportViewListGetResponse
3.1.4.30.2 Elements
The following XML schema element definitions are specific to the ExportViewListGet operation.
3.1.4.30.2.1 ExportViewListGetRequest
The ExportViewListGetRequest element specifies the details of the request to get the export view
list.
172 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.30.2.2 ExportViewListGetResponse
<xs:element name="ExportViewListGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q93="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="ExportViews" nillable="true" type="q93:ArrayOfExportView" />
<xs:element xmlns:q94="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q94:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
ExportViews: Specifies a collection of export views that are returned by using the
ArrayOfExportView complex type.
3.1.4.31 SecurityPrincipalsClone
<wsdl:operation name="SecurityPrincipalsClone">
<soap12:operation
soapAction="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Securi
tyPrincipalsClone" style="document"/>
<wsdl:input name="SecurityPrincipalsRequest">
<wsp:PolicyReference URI="#WSHttpBinding_IService_SecurityPrincipalsClone_Input_policy"/>
<soap12:header message="tns:SecurityPrincipalsRequest_Headers" part="International"
use="literal"/>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output name="MessageResponse">
<wsp:PolicyReference URI="#WSHttpBinding_IService_SecurityPrincipalsClone_output_policy"/>
<soap12:body use="literal"/>
</wsdl:output>
173 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.31.1 Messages
The following WSDL message definitions are specific to the SecurityPrincipalsClone operation.
3.1.4.31.1.1 SecurityPrincipalsRequest
3.1.4.31.2 Elements
The following XML schema element definitions are specific to the SecurityPrincipalsClone
operation.
3.1.4.32 SecurityPrincipalsCreate
The SecurityPrincipalsCreate operation creates a security principal object in the MDM repository.
<wsdl:operation name="SecurityPrincipalsCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsCreate" name="SecurityPrincipalsRequest"
message="tns:SecurityPrincipalsRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsCreateResponse" name="SecurityCreateResponse"
message="tns:SecurityCreateResponse"/>
</wsdl:operation>
3.1.4.32.1 Messages
The following WSDL message definitions are specific to the SecurityPrincipalsCreate operation.
3.1.4.32.1.1 SecurityPrincipalsRequest
3.1.4.32.1.2 SecurityCreateResponse
3.1.4.32.2 Elements
The following XML schema element definitions are specific to the SecurityPrincipalsCreate
operation.
174 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The SecurityCreateResponse element may contain a set of identifiers for newly created principals
and/or permissions.
<xs:element name="SecurityCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q96="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="OperationResult" nillable="true" type="q96:OperationResult" />
<xs:element xmlns:q97="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="SecuritySet" nillable="true" type="q97:SecuritySet" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.33 SecurityPrincipalsGet
The SecurityPrincipalsGet operation gets the security principals data in whole or in parts.
<wsdl:operation name="SecurityPrincipalsGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsGet" name="SecurityPrincipalsGetRequest"
message="tns:SecurityPrincipalsGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsGetResponse" name="SecurityPrincipalsGetResponse"
message="tns:SecurityPrincipalsGetResponse" />
</wsdl:operation>
3.1.4.33.1 Messages
The following XSD schema message definitions are specific to the SecurityPrincipalsGet operation.
3.1.4.33.1.1 SecurityPrincipalsGetRequest
3.1.4.33.1.2 SecurityPrincipalsGetResponse
3.1.4.33.2 Elements
The following XML schema element definitions are specific to the SecurityPrincipalsGet operation.
175 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="SecurityPrincipalsGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q99="http://schemas.microsoft.com/office/mdm/2007/11" minOccurs="0"
name="Criteria" nillable="true" type="q99:SecurityPrincipalsCriteria" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.33.2.2 SecurityPrincipalsGetResponse
<xs:element name="SecurityPrincipalsGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q100="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q100:OperationResult" />
<xs:element xmlns:q101="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Principals" nillable="true" type="q101:SecurityPrincipals" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.34 SecurityPrincipalsDelete
<wsdl:operation name="SecurityPrincipalsDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsDelete" name="SecurityPrincipalsDeleteRequest"
message="tns:SecurityPrincipalsDeleteRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsDeleteResponse" name="MessageResponse" message="tns:MessageResponse"/>
</wsdl:operation>
3.1.4.34.1 Messages
The following XSD schema message definitions are specific to the SecurityPrincipalsDelete
operation.
176 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.34.2 Elements
The following XML schema element definitions are specific to the SecurityPrincipalsDelete
operation.
3.1.4.34.2.1 SecurityPrincipalsDeleteRequest
<xs:element name="SecurityPrincipalsDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q102="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Critiera" nillable="true" type="q102:SecurityPrincipalsDeleteCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the SecurityPrincipalsDelete
operation.
3.1.4.34.3.1 SecurityPrincipalsDeleteCriteria
<xs:complexType name="SecurityPrincipalsDeleteCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="Groups" nillable="true" type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="Users" nillable="true" type="tns:ArrayOfIdentifier" />
</xs:sequence>
</xs:complexType>
177 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The SecurityPrivilegesClone operation creates exact copies of permissions within the security
model in the MDM repository.
<wsdl:operation name="SecurityPrivilegesClone">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesClone" name="SecurityPrivilegesRequest"
message="tns:SecurityPrivilegesRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesCloneResponse" name="MessageResponse" message="tns:MessageResponse"/>
</wsdl:operation>
3.1.4.35.1 Messages
The following XSD schema message definitions are specific to the SecurityPrivilegesClone
operation.
3.1.4.35.1.1 SecurityPrivilegesRequest
3.1.4.35.2 Elements
The following XML schema element definitions are specific to the SecurityPrivilegesClone
operation.
3.1.4.35.2.1 SecurityPrivilegesRequest
The SecurityPrivilegesRequest request element specifies the security privileges for the
SecurityPrivilegesClone operation.
<xs:element name="SecurityPrivilegesRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q103="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Privileges" nillable="true" type="q103:SecurityPrivileges" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
178 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The SecurityPrivilegesGet operation retrieves security privilege information from the MDM
repository.
<wsdl:operation name="SecurityPrivilegesGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesGet" name="SecurityPrivilegesGetRequest"
message="tns:SecurityPrivilegesGetRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesGetResponse" name="SecurityPrivilegesGetResponse"
message="tns:SecurityPrivilegesGetResponse"/>
</wsdl:operation>
3.1.4.36.1 Messages
The following XSD schema message definitions are specific to the SecurityPrivilegesGet operation.
3.1.4.36.1.1 SecurityPrivilegesGetRequest
3.1.4.36.1.2 SecurityPrivilegesGetResponse
3.1.4.36.2 Elements
The following XML schema element definitions are specific to the SecurityPrivilegesGet operation.
3.1.4.36.2.1 SecurityPrivilegesGetRequest
<xs:element name="SecurityPrivilegesGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q104="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Criteria" nillable="true" type="q104:SecurityPrivilegesGetCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
179 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="SecurityPrivilegesGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q105="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q105:OperationResult" />
<xs:element xmlns:q106="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Privileges" nillable="true" type="q106:SecurityPrivileges" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the SecurityPrivilegesGet
operation.
3.1.4.36.3.1 SecurityPrivilegesGetCriteria
The SecurityPrivilegesGetCriteria complex type specifies the criteria for specifying the types of
security privileges to return.
The following is the XSD schema definition of the SecurityPrivilegesGetCriteria complex type.
<xs:complexType name="SecurityPrivilegesGetCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="FunctionPrivilegesCriteria" nillable="true"
type="tns:FunctionPrivilegesCriteria" />
<xs:element minOccurs="0" name="HierarchyMemberPrivilegesCriteria" nillable="true"
type="tns:HierarchyMemberPrivilegesCriteria" />
<xs:element minOccurs="0" name="ModelPrivilegesCriteria" nillable="true"
type="tns:ModelPrivilegesCriteria" />
</xs:sequence>
</xs:complexType>
180 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The FunctionPrivilegesCriteria complex type specifies the criteria for function privileges.
The following is the XSD schema definition of the FunctionPrivilegesCriteria complex type.
<xs:complexType name="FunctionPrivilegesCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="Identifiers" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="IsAuthorized" type="xs:boolean" />
<xs:element minOccurs="0" name="PrincipalId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q32="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="PrincipalType" type="q32:PrincipalType" />
<xs:element minOccurs="0" name="ResultType" type="tns:ResultType" />
</xs:sequence>
</xs:complexType>
Identifiers: Specifies an ArrayOfIdentifier instance that specifies the function privilege identifiers.
3.1.4.36.3.3 HierarchyMemberPrivilegesCriteria
<xs:complexType name="HierarchyMemberPrivilegesCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="HierarchyId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q33="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="HierarchyType" type="q33:HierarchyType" />
<xs:element minOccurs="0" name="Identifiers" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="MemberCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q34="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q34:Permission" />
<xs:element minOccurs="0" name="PrincipalId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q35="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="PrincipalType" type="q35:PrincipalType" />
<xs:element minOccurs="0" name="ResultType" type="tns:ResultType" />
181 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Identifiers: Specifies an ArrayOfIdentifier instance that specifies the hierarchy member privilege
identifiers.
3.1.4.36.3.4 ModelPrivilegesCriteria
The following is the XSD schema definition of the ModelPrivilegesCriteria complex type.
<xs:complexType name="ModelPrivilegesCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="Identifiers" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="ObjectId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q36="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="Permission" type="q36:Permission" />
<xs:element minOccurs="0" name="PrincipalId" nillable="true" type="tns:Identifier" />
<xs:element
xmlns:q37="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="PrincipalType" type="q37:PrincipalType" />
<xs:element minOccurs="0" name="ResultType" type="tns:ResultType" />
</xs:sequence>
</xs:complexType>
Identifiers: Specifies an ArrayOfIdentifier instance that specifies the model privilege identifiers.
182 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.37 SecurityPrivilegesDelete
The SecurityPrivilegesDelete operation deletes security privilege information from the MDM
repository.
<wsdl:operation name="SecurityPrivilegesDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesDelete" name="SecurityPrivilegesDeleteRequest"
message="tns:SecurityPrivilegesDeleteRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesDeleteResponse" name="MessageResponse" message="tns:MessageResponse"/>
</wsdl:operation>
3.1.4.37.1 Messages
The following XSD schema message definitions are specific to the SecurityPrivilegesDelete
operation.
3.1.4.37.1.1 SecurityPrivilegesDeleteRequest
3.1.4.37.2 Elements
The following XML schema element definitions are specific to the SecurityPrivilegesDelete
operation.
3.1.4.37.2.1 SecurityPrivilegesDeleteRequest
<xs:element name="SecurityPrivilegesDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q107="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Critiera" nillable="true" type="q107:SecurityPrivilegesDeleteCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
183 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema complex type definitions are specific to the SecurityPrivilegesDelete
operation.
3.1.4.37.3.1 SecurityPrivilegesDeleteCriteria
The SecurityPrivilegesDeleteCriteria complex type specifies the criteria for deleting security
privileges.
The following is the XSD schema definition of the SecurityPrivilegesDeleteCriteria complex type.
<xs:complexType name="SecurityPrivilegesDeleteCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="FunctionPrivileges" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="HierarchyMemberPrivileges" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="ModelPrivileges" nillable="true"
type="tns:ArrayOfIdentifier" />
</xs:sequence>
</xs:complexType>
3.1.4.38 MetadataClone
The MetadataClone operation creates a copy of a metadata item that is linked to the original via
the shared GUID. This operation is similar to MetadataCreate except as specified here.
The MetadataClone operation requires both the GUID and the name of new items in the request.
The GUID is inserted rather than generated. If the request contains a GUID that matches an existing
object in the hub of the same type, that object is updated.
The identifiers of each new item MUST include the GUID and the name. The name MUST NOT exist
within the specified context for an item with another GUID.
<wsdl:operation name="MetadataClone">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataClone" name="MetadataCloneRequest" message="tns:MetadataCloneRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataCloneResponse" name="MetadataCloneResponse" message="tns:MetadataCloneResponse" />
</wsdl:operation>
184 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following WSDL message definitions are specific to the MetadataClone operation.
3.1.4.38.1.1 MetadataCloneRequest
3.1.4.38.1.2 MetadataCloneResponse
3.1.4.38.2 Elements
The following XML schema element definitions are specific to the MetadataClone operation.
3.1.4.38.2.1 MetadataCloneRequest
The MetadataCloneRequest request element MUST include a Metadata complex type that contains
objects to be applied to the MDS repository.
<xs:element name="MetadataCloneRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q108="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Metadata" nillable="true" type="q108:Metadata" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.38.2.2 MetadataCloneResponse
<xs:element name="MetadataCloneResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q109="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q109:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
185 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The MetadataGet operation searches for and returns metadata from an MDS repository. The
request is comprised of SearchCriteria and MetadataResultOptions. The response contains the
results of the search (such as items that match the search criteria) and returns the metadata in a
format and to a level of detail as specified in MetadataResultOptions.
Various metadata components can be searched, including models, entities, attributes, derived
hierarchies, hierarchies, member types, versions, and attribute groups. Each metadata
component has a corresponding list of identifiers within the search criteria. To find objects by
GUIDs and/or names, the identifiers are populated.
The GUIDs and names from each list are combined with AND logic. For example, providing the
criteria Model.ID=some-guid1 and the criteria Entity.ID=some-guid2 filters for objects where
(Model.ID=some-guid1 AND Entity.ID=some-guid2).
Providing multiple IDs or names within the same criteria list looks for all items in the set. For
example, providing the criteria Model.ID(1)=some-guid1 and Model.ID(2)=some-guid2 and the
criteria Entity.ID=some-guid3 filters for objects where (Model.ID IN [some-guid1, some-guid2]
AND Entity.ID=some-guid3).
For each property of the Metadata complex type, the MetadataResultOptions type specifies the
inclusion and level of detail to return in the response.
The information that is retrieved for each component is based on the following possible result
type settings:
None: No data is returned for this component (this is the default value).
Identifiers: Identifiers (GUIDs and names) and other properties are retrieved for this
component.
Details: Full data is populated for this component, including child objects.
<wsdl:operation name="MetadataGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataGet" name="MetadataGetRequest" message="tns:MetadataGetRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataGetResponse" name="MetadataGetResponse" message="tns:MetadataGetResponse"/>
</wsdl:operation>
3.1.4.39.1 Messages
The following WSDL message definitions are specific to the MetadataGet operation.
3.1.4.39.1.1 MetadataGetRequest
186 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.39.2 Elements
The following XML schema element definitions are specific to the MetadataGet operation.
3.1.4.39.2.1 MetadataGetRequest
<xs:element name="MetadataGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q115="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="MetadataResultOptions" nillable="true" type="q115:MetadataResultOptions"
/>
<xs:element xmlns:q116="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SearchCriteria" nillable="true" type="q116:SearchCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.39.2.2 MetadataGetResponse
The MetadataGetResponse response element includes a Metadata type as a container for any
requested metadata information.
<xs:element name="MetadataGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q117="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Metadata" nillable="true" type="q117:Metadata" />
<xs:element xmlns:q118="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q118:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
187 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema complex type definitions are specific to the MetadataGet operation.
3.1.4.39.3.1 SearchCriteria
The SearchCriteria complex type allows specification of identifiers that are associated with each
type of metadata object.
The following is the XSD schema definition of the SearchCriteria complex type.
<xs:complexType name="SearchCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeGroups" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="Attributes" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="DerivedHierarchies" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="DerivedHierarchyLevels" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="Entities" nillable="true" type="tns:ArrayOfIdentifier"
/>
<xs:element minOccurs="0" name="ExplicitHierarchies" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="MemberTypes" nillable="true"
type="tns:ArrayOfMemberType" />
<xs:element minOccurs="0" name="Models" nillable="true" type="tns:ArrayOfIdentifier" />
<xs:element
xmlns:q47="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="SearchOption" type="q47:SearchOption" />
<xs:element minOccurs="0" name="VersionFlags" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="Versions" nillable="true" type="tns:ArrayOfIdentifier"
/>
</xs:sequence>
</xs:complexType>
3.1.4.39.3.2 MetadataResultOptions
The following is the XSD schema definition of the MetadataResultOptions complex type.
<xs:complexType name="MetadataResultOptions">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeGroups" type="tns:ResultType" />
<xs:element minOccurs="0" name="Attributes" type="tns:ResultType" />
<xs:element minOccurs="0" name="DerivedHierarchies" type="tns:ResultType" />
<xs:element minOccurs="0" name="DerivedHierarchyLevels" type="tns:ResultType" />
<xs:element minOccurs="0" name="Entities" type="tns:ResultType" />
<xs:element minOccurs="0" name="ExplicitHierarchies" type="tns:ResultType" />
<xs:element minOccurs="0" name="MemberTypes" type="tns:ResultType" />
188 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.40 MetadataUpdate
The MetadataUpdate operation updates existing metadata objects within an MDS repository.
Items in the request are matched to the existing objects based on only the GUID. Like any other
property, an object's name is updated if the name of the item in the request is different than in the
MDS repository. Each GUID that is not found is returned as a separate error. Each object's update is
attempted and individually committed regardless of the failure of other items.
Only one property of Metadata may be populated in the request message. An error is returned if
there is more than one. This eliminates the possibility that a request message contains conflicting
information about the same object in different parts of the Metadata type.
<wsdl:operation name="MetadataUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataUpdate" name="MetadataUpdateRequest" message="tns:MetadataUpdateRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataUpdateResponse" name="MetadataUpdateResponse" message="tns:MetadataUpdateResponse"/>
</wsdl:operation>
3.1.4.40.1 Messages
The following WSDL message definitions are specific to the MetadataUpdate operation.
3.1.4.40.1.1 MetadataUpdateRequest
3.1.4.40.1.2 MetadataUpdateResponse
3.1.4.40.2 Elements
The following XML schema element definitions are specific to the MetadataUpdate operation.
3.1.4.40.2.1 MetadataUpdateRequest
The MetadataUpdateRequest request element MUST include a Metadata complex type that
contains objects to be updated in the MDS repository.
189 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="MetadataUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q119="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Metadata" nillable="true" type="q119:Metadata" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.40.2.2 MetadataUpdateResponse
<xs:element name="MetadataUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q120="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q120:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.41 MetadataCreate
The MetadataCreate operation creates new metadata objects. The operation creates new objects
with the names that are provided and generates a new GUID for each new object.
GUIDs may be included in the request; however, they are ignored. For more information about
assigning GUIDs to newly created objects, see section 3.1.4.38.
Names for new objects MUST be unique within their context. A name that conflicts with an existing
name in the assigned context results in an error.
Newly created objects and their GUIDs are returned in the response if the value of
ReturnCreatedIdentifiers is true.
For each of the following objects, a minimum context MUST be specified as listed in the following
table.
Entity Model
190 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="MetadataCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataCreate" name="MetadataCreateRequest" message="tns:MetadataCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataCreateResponse" name="MetadataCreateResponse" message="tns:MetadataCreateResponse" />
</wsdl:operation>
3.1.4.41.1 Messages
The following WSDL message definitions are specific to the MetadataCreate operation.
3.1.4.41.1.1 MetadataCreateRequest
3.1.4.41.1.2 MetadataCreateResponse
3.1.4.41.2 Elements
The following XML schema element definitions are specific to the MetadataCreate operation.
3.1.4.41.2.1 MetadataCreateRequest
The MetadataCreateRequest request element MUST include a Metadata complex type that
contains objects to be created in the MDS repository.
<xs:element name="MetadataCreateRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q110="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="Metadata" nillable="true" type="q110:Metadata" />
<xs:element minOccurs="0" name="ReturnCreatedIdentifiers" type="xs:boolean" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
191 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.41.2.2 MetadataCreateResponse
The MetadataCreateResponse response element may echo the created metadata objects in a
Metadata complex type if requested.
<xs:element name="MetadataCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q111="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="MetadataCreated" nillable="true" type="q111:Metadata" />
<xs:element xmlns:q112="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q112:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
MetadataCreated: Specifies a Metadata complex type that contains the objects that are created,
including their assigned GUIDs.
3.1.4.42 MetadataDelete
The MetadataDelete operation deletes metadata objects from an MDS repository. The request's
Metadata element identifies objects to be deleted. One or more objects may be specified within a
single request. The objects that are specified may be of the same or multiple object types. Objects
are located by GUIDs only; names are ignored.
This operation issues individual Delete operations for each item. The failure or inability to delete one
item does not affect the attempt to delete or the successful deletion of other items that are explicitly
included in the request. Multiple calls for individual items may be implemented if alternative error-
handling is required.
Deletions of some metadata components are cascading and automatically delete their child
components. This occurs in cases in which the components are fully dependent on the deleted
component and therefore have no further usefulness without the deleted component.
All related metadata subcomponents (such as entities, attributes, hierarchies, and versions) are
deleted.
192 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The related metadata sub-components (such as attributes, attribute groups, and explicit
hierarchies) are deleted.
Associated model and hierarchy member security permissions (such as model security
permissions assigned at the entity component or below) are deleted.
An error occurs when an attempt is made to delete a component when one or more of the following
conditions are true:
An entity, attribute, or explicit hierarchy is deleted when used by a derived hierarchy.
An explicit hierarchy is deleted when a business rule references parents within the hierarchy.
<wsdl:operation name="MetadataDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataDelete" name="MetadataDeleteRequest" message="tns:MetadataDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Metad
ataDeleteResponse" name="MetadataDeleteResponse" message="tns:MetadataDeleteResponse" />
</wsdl:operation>
3.1.4.42.1 Messages
The following WSDL message definitions are specific to the MetadataDelete operation.
3.1.4.42.1.1 MetadataDeleteRequest
3.1.4.42.1.2 MetadataDeleteResponse
3.1.4.42.2 Elements
The following XML schema element definitions are specific to the MetadataDelete operation.
3.1.4.42.2.1 MetadataDeleteRequest
The MetadataDeleteRequest request element MUST include a Metadata complex type that
contains objects to be deleted from the MDS repository. The object identifiers MUST include GUIDs.
193 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.42.2.2 MetadataDeleteResponse
<xs:element name="MetadataDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q114="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q114:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.43 SystemSettingsGet
The SystemSettingsGet operation retrieves system configuration settings. One selected group of
system configuration settings can be retrieved. The setting group to retrieve is specified by
Identifier in SystemSettingsGetCriteria.
<wsdl:operation name="SystemSettingsGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mSettingsGet" name="SystemSettingsGetRequest" message="tns:SystemSettingsGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mSettingsGetResponse" name="SystemSettingsGetResponse"
message="tns:SystemSettingsGetResponse" /> </wsdl:operation>
3.1.4.43.1 Messages
The following WSDL message definitions are specific to the SystemSettingsGet operation.
194 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.43.1.2 SystemSettingsGetResponse
3.1.4.43.2 Elements
The following XML schema element definitions are specific to the SystemSettingsGet operation.
3.1.4.43.2.1 SystemSettingsGetRequest
The following is the XSD schema definition of the SystemSettingsGetRequest request element.
<xs:element name="SystemSettingsGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q121="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SearchCriteria" nillable="true" type="q121:SystemSettingsGetCriteria" />
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.43.2.2 SystemSettingsGetResponse
<xs:element name="SystemSettingsGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q122="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q122:OperationResult" />
<xs:element xmlns:q123="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SystemSettingsGroups" nillable="true"
type="q123:ArrayOfSystemSettingGroup" />
</xs:sequence>
</xs:complexType>
</xs:element>
195 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema complex type definitions are specific to the SystemSettingsGet
operation.
3.1.4.43.3.1 SystemSettingsGetCriteria
The SystemSettingsGetCriteria complex type identifies a system settings group for retrieval.
The following is the XSD schema definition of the SystemSettingsGetCriteria complex type.
<xs:complexType name="SystemSettingsGetCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="Group" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
3.1.4.44 SystemSettingsUpdate
System settings are specified by a keyword string. An error occurs when a setting that does not
exist is specified.
<wsdl:operation name="SystemSettingsUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mSettingsUpdate" name="SystemSettingsUpdateRequest" message="tns:SystemSettingsUpdateRequest"
/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mSettingsUpdateResponse" name="SystemSettingsUpdateResponse"
message="tns:SystemSettingsUpdateResponse" />
</wsdl:operation>
3.1.4.44.1 Messages
The following WSDL message definitions are specific to the SystemSettingsUpdate operation.
3.1.4.44.1.1 SystemSettingsUpdateRequest
196 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.44.2 Elements
The following XML schema element definitions are specific to the SystemSettingsUpdate
operation.
3.1.4.44.2.1 SystemSettingsUpdateRequest
<xs:element name="SystemSettingsUpdateRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
<xs:element xmlns:q124="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SystemSettingGroups" nillable="true"
type="q124:ArrayOfSystemSettingGroup" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.44.2.2 SystemSettingsUpdateResponse
<xs:element name="SystemSettingsUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q125="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q125:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.45 SystemDomainListGet
The SystemDomainListGet operation retrieves a standard list of text choices that are associated
with the MDS application. The returned list is localized based on the user's locale.
197 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ListOption: Specifies an individual list option on which to filter within the list where applicable. If
a list option is not specified, all list options are returned.
ListGroup: Specifies a list group ID on which to filter where applicable. If a list group is not
specified, all list groups are returned.
<wsdl:operation name="SystemDomainListGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mDomainListGet" name="SystemDomainListGetRequest" message="tns:SystemDomainListGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mDomainListGetResponse" name="SystemDomainListGetResponse"
message="tns:SystemDomainListGetResponse" />
</wsdl:operation>
3.1.4.45.1 Messages
The following WSDL message definitions are specific to the SystemDomainListGet operation.
3.1.4.45.1.1 SystemDomainListGetRequest
3.1.4.45.1.2 SystemDomainListGetResponse
3.1.4.45.2 Elements
The following XML schema element definitions are specific to the SystemDomainListGet operation.
3.1.4.45.2.1 SystemDomainListGetRequest
<xs:element name="SystemDomainListGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q126="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SearchCriteria" nillable="true" type="q126:SystemDomainListGetCriteria"
/>
198 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.45.2.2 SystemDomainListGetResponse
<xs:element name="SystemDomainListGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q127="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q127:OperationResult" />
<xs:element xmlns:q128="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SystemDomainLists" nillable="true" type="q128:ArrayOfSystemDomainList" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the SystemDomainListGet
operation.
3.1.4.45.3.1 SystemDomainListGetCriteria
The SystemDomainListGetCriteria complex type captures query criteria for system domain lists.
The following is the XSD schema definition of the SystemDomainListGetCriteria complex type.
<xs:complexType name="SystemDomainListGetCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="ListCode" nillable="true" type="xs:string" />
<xs:element minOccurs="0" name="ListGroup" nillable="true" type="xs:int" />
<xs:element minOccurs="0" name="ListOption" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
ListCode: Specifies the name of the domain list on which to filter. If this value is not specified, all
domain lists are returned.
ListGroup: Specifies the integer code of the individual list grouping, or category, on which to filter.
If this value is not specified, all list groups are returned.
199 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.46 SystemPropertiesGet
The SystemPropertiesGet operation retrieves available read-only properties about the system.
This operation has no request parameters and responds with all available system properties. This
operation currently provides database disk size information, but this operation could be extended to
include other values in the future.
DatabaseMaxSizeMB: The maximum size of the data (MDF) database files in megabytes.
The returned database sizes are for data files only; log files are not included. This feature
supports a hosting scenario in which the host is likely to set restricted file growth to a maximum
size of the data file, and the tenant periodically has to determine how much of his or her total
allocated size has been used.
Calculations are based on the output of sp_spaceused. This procedure produces two result sets.
The first result set includes "unallocated space" in megabytes, and the second result set includes
"reserved" in kilobytes.
<wsdl:operation name="SystemPropertiesGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mPropertiesGet" name="SystemPropertiesGetRequest" message="tns:SystemPropertiesGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Syste
mPropertiesGetResponse" name="SystemPropertiesGetResponse"
message="tns:SystemPropertiesGetResponse" />
</wsdl:operation>
3.1.4.46.1 Messages
The following XSD schema message definitions are specific to the SystemPropertiesGet operation.
3.1.4.46.1.1 SystemPropertiesGetRequest
200 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.46.2 Elements
The following XML schema element definitions are specific to the SystemPropertiesGet operation.
3.1.4.46.2.1 SystemPropertiesGetRequest
<xs:element name="SystemPropertiesGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.46.2.2 SystemPropertiesGetResponse
<xs:element name="SystemPropertiesGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q129="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q129:OperationResult" />
<xs:element xmlns:q130="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="SystemProperties" nillable="true" type="q130:ArrayOfSystemPropertyValue"
/>
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the SystemPropertiesGet
operation.
201 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following is the XSD schema definition of the ArrayOfSystemPropertyValue complex type.
<xs:complexType name="ArrayOfSystemPropertyValue">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="SystemPropertyValue"
nillable="true" type="tns:SystemPropertyValue" />
</xs:sequence>
</xs:complexType>
3.1.4.46.3.2 SystemPropertyValue
The SystemPropertyValue complex type contains a system property and its value.
The following is the XSD schema definition of the SystemPropertyValue complex type.
<xs:complexType name="SystemPropertyValue">
<xs:sequence>
<xs:element
xmlns:q48="http://schemas.datacontract.org/2004/07/Microsoft.Office.MDM.Services.DataContract
s" minOccurs="0" name="SystemPropertyType" type="q48:SystemPropertyType" />
<xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" />
</xs:sequence>
</xs:complexType>
Value: Specifies a string that contains the value of the system property.
The following XML schema simple definitions are specific to the SystemPropertiesGet operation.
3.1.4.46.4.1 SystemPropertyType
The SystemPropertyType simple type lists the unique names of the available system properties as
strings. For descriptions of the properties, see section 3.1.4.46.
The following is the XSD schema definition of the SystemPropertyType simple type.
<xs:simpleType name="SystemPropertyType">
<xs:restriction base="xs:string">
<xs:enumeration value="DatabaseMaxSizeMB" />
<xs:enumeration value="DatabaseUsedSizeMB" />
</xs:restriction>
202 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.47 VersionCopy
The VersionCopy operation copies an existing version to a new version, including all data.
The version to be copied MUST be specified by version GUID (by using the FromVersionId
parameter). Optional parameters for the target version can be specified, including name
(ToVersionName) and description (ToVersionDescription). If a name is not specified, the default
name "Copy [n] of <old version name>" is applied.
The target name MUST not exist. A pre-existing target name results in an error and no copy.
The operation checks the CopyOnlyCommittedVersion system setting and does not copy an
uncommitted version if not allowed.
<wsdl:operation name="VersionCopy">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Versi
onCopy" name="VersionCopyRequest" message="tns:VersionCopyRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Versi
onCopyResponse" name="VersionCopyResponse" message="tns:VersionCopyResponse" />
</wsdl:operation>
3.1.4.47.1 Messages
The following WSDL message definitions are specific to the VersionCopy operation.
3.1.4.47.1.1 VersionCopyRequest
3.1.4.47.1.2 VersionCopyResponse
3.1.4.47.2 Elements
The following XML schema element definitions are specific to the VersionCopy operation.
3.1.4.47.2.1 VersionCopyRequest
The VersionCopyRequest request element MUST include the FromVersionId property as a GUID.
It may also include the following string properties:
ToVersionName
ToVersionDescription
203 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
ToVersionName: Specifies an optional string that contains the name of the new version.
ToVersionDescription: Specifies an optional string that contains the description of the new
version.
3.1.4.47.2.2 VersionCopyResponse
<xs:element name="VersionCopyResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q132="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q132:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.48 UserPreferencesGet
The UserPreferencesGet operation retrieves the current user's preferences that were previously
saved within the MDS repository. User preferences support persistent storage of user state
properties where appropriate. This operation requires no input criteria and retrieves all preference
settings that are available for the current user.
<wsdl:operation name="UserPreferencesGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesGet" name="UserPreferencesGetRequest" message="tns:UserPreferencesGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesGetResponse" name="UserPreferencesGetResponse"
message="tns:UserPreferencesGetResponse" />
</wsdl:operation>
204 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XSD schema message definitions are specific to the UserPreferencesGet operation.
3.1.4.48.1.1 UserPreferencesGetRequest
3.1.4.48.1.2 UserPreferencesGetResponse
3.1.4.48.2 Elements
The following XML schema element definitions are specific to the UserPreferencesGet operation.
3.1.4.48.2.1 UserPreferencesGetRequest
<xs:element name="UserPreferencesGetRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="ServiceConnectionName" nillable="true"
type="xs:string" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.48.2.2 UserPreferencesGetResponse
<xs:element name="UserPreferencesGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q133="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q133:OperationResult" />
<xs:element xmlns:q134="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
minOccurs="0" name="UserPreferences" nillable="true"
type="q134:ArrayOfKeyValueOfstringstring" />
</xs:sequence>
</xs:complexType>
</xs:element>
205 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.49 UserPreferencesUpdate
The UserPreferencesUpdate operation updates the current user's preferences within the MDS
repository. User preferences support persistent storage of user state properties where appropriate.
<wsdl:operation name="UserPreferencesUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesUpdate" name="UserPreferencesUpdateRequest"
message="tns:UserPreferencesUpdateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesUpdateResponse" name="UserPreferencesUpdateResponse"
message="tns:UserPreferencesUpdateResponse" />
</wsdl:operation>
3.1.4.49.1 Messages
The following XSD schema message definitions are specific to the UserPreferencesUpdate
operation.
3.1.4.49.1.1 UserPreferencesUpdateRequest
3.1.4.49.1.2 UserPreferencesUpdateResponse
3.1.4.49.2 Elements
The following XML schema element definitions are specific to the UserPreferencesUpdate
operation.
3.1.4.49.2.1 UserPreferencesUpdateRequest
<xs:element name="UserPreferencesUpdateRequest">
<xs:complexType>
<xs:sequence>
206 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.49.2.2 UserPreferencesUpdateResponse
<xs:element name="UserPreferencesUpdateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q136="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q136:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.50 UserPreferencesDelete
The UserPreferencesDelete operation deletes the current user's selected preferences within the
MDS repository. One or more preferences can be specified for deletion by submitting a dictionary
list. Or, all saved preferences can be deleted by setting DeleteAllUserPreferences to true.
<wsdl:operation name="UserPreferencesDelete">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesDelete" name="UserPreferencesDeleteRequest"
message="tns:UserPreferencesDeleteRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/UserP
referencesDeleteResponse" name="UserPreferencesDeleteResponse"
message="tns:UserPreferencesDeleteResponse" />
</wsdl:operation>
3.1.4.50.1 Messages
The following XSD schema message definitions are specific to the UserPreferencesDelete
operation.
207 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.50.1.2 UserPreferencesDeleteResponse
3.1.4.50.2 Elements
The following XML schema element definitions are specific to the UserPreferencesDelete
operation.
3.1.4.50.2.1 UserPreferencesDeleteRequest
<xs:element name="UserPreferencesDeleteRequest">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" name="DeleteAllUserPreferences" type="xs:boolean" />
<xs:element xmlns:q137="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
minOccurs="0" name="UserPreferences" nillable="true"
type="q137:ArrayOfKeyValueOfstringstring" />
</xs:sequence>
</xs:complexType>
</xs:element>
DeleteAllUserPreferences: Specifies a Boolean that causes the deletion of all preferences for the
current user when it is set to true.
3.1.4.50.2.2 UserPreferencesDeleteResponse
<xs:element name="UserPreferencesDeleteResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q138="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q138:OperationResult" />
</xs:sequence>
208 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.51 BusinessRulesPaletteGet
Default value
Change value
Validation
<wsdl:operation name="BusinessRulesPaletteGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesPaletteGet" name="BusinessRulesPaletteGetRequest"
message="tns:BusinessRulesPaletteGetRequest"/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesPaletteGetResponse" name="BusinessRulesPaletteGetResponse"
message="tns:BusinessRulesPaletteGetResponse"/>
</wsdl:operation>
3.1.4.51.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesPaletteGet
operation.
3.1.4.51.1.1 BusinessRulesPaletteGetRequest
3.1.4.51.1.2 BusinessRulesPaletteGetResponse
3.1.4.51.2 Elements
The following XML schema element definitions are specific to the BusinessRulesPaletteGet
operation.
209 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<xs:element name="BusinessRulesPaletteGetRequest"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexType>
<xs:sequence>
<xs:element
xmlns:q316="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09" minOccurs="0"
name="MemberType" type="q316:BREntityMemberType" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.51.2.2 BusinessRulesPaletteGetResponse
<xs:element name="BusinessRulesPaletteGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q140="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="BusinessRulesPalette" nillable="true" type="q140:BusinessRulesPalette" />
<xs:element xmlns:q141="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q141:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.52 BusinessRulesClone
The BusinessRulesClone operation creates new business rule objects as exact copies of objects in
another MDM hub instance. This operation is similar to BusinessRulesCreate except as specified
here.
The GUID of each item (and the name for business rules) is required in the request. Rules have
names, but actions, conditions, and condition tree nodes do not. The GUID is inserted rather than
generated (as in a Create operation). If the request contains a GUID that matches an existing object
in the hub of the same type, that object is updated.
210 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="BusinessRulesClone">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesClone" name="BusinessRulesCloneRequest" message="tns:BusinessRulesCloneRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesCloneResponse" name="MessageResponse" message="tns:MessageResponse" />
</wsdl:operation>
3.1.4.52.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesClone operation.
3.1.4.52.1.1 BusinessRulesCloneRequest
3.1.4.52.2 Elements
The following XML schema element definitions are specific to the BusinessRulesClone operation.
3.1.4.52.2.1 BusinessRulesCloneRequest
The following is the XSD schema definition of the BusinessRulesCloneRequest request element.
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.53 BusinessRulesCreate
The BusinessRulesCreate operation creates new business rules and business rule components
within the MDS repository. Each new business rule or component is created with the names that are
provided, and a new GUID is generated for each item. Any components in the request that already
exist in the model, matched by name and parent context (EntityId and MemberType), result in
errors.
211 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
GUIDs may be included in a request (for example, the business rule definition was sourced from
another MDM hub instance). However, the GUIDs are ignored. For more information about the
preservation of GUIDs, see section 3.1.4.52.
Newly created objects and their GUIDs are returned in the response as a BusinessRules type if
ReturnCreatedIdentifiers is set to true in the request.
Specified domain-based attribute values in arguments of conditions or actions are validated against
all open versions. Attribute values that are not found result in errors.
<wsdl:operation name="BusinessRulesCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesCreate" name="BusinessRulesCreateRequest" message="tns:BusinessRulesCreateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesCreateResponse" name="BusinessRulesCreateResponse"
message="tns:BusinessRulesCreateResponse" />
</wsdl:operation>
3.1.4.53.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesCreate operation.
3.1.4.53.1.1 BusinessRulesCreateRequest
3.1.4.53.1.2 BusinessRulesCreateResponse
3.1.4.53.2 Elements
The following XML schema element definitions are specific to the BusinessRulesCreate operation.
3.1.4.53.2.1 BusinessRulesCreateRequest
212 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
</xs:sequence>
</xs:complexType>
</xs:element>
ReturnCreatedIdentifiers: Specifies a Boolean that is set to true to request the return of created
items, including their assigned GUIDs.
3.1.4.53.2.2 BusinessRulesCreateResponse
<xs:element name="BusinessRulesCreateResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q144="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="BusinessRuleSet" nillable="true" type="q144:BusinessRules" />
<xs:element xmlns:q145="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q145:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
BusinessRuleSet: Specifies a BusinessRules complex type that echoes the created items if
ReturnCreatedItems is set to true in the request.
3.1.4.54 BusinessRulesDelete
The BusinessRulesDelete operation deletes one or more business rules or deletes conditions or
actions from business rules. This operation issues individual Delete transactions for each item. An
error is reported for each item that is not found.
The failure or inability to delete one item does not affect the attempt to delete or the successful
deletion of other items. Multiple granular calls for individual items can be implemented if alternative
error handling is required.
With the input from BRDeleteCriteria, one of the following sets of GUIDs is specified:
The GUIDs of the conditions, actions, or condition tree nodes (ANDs, ORs) of the business rules.
Delete transactions cascade to dependent objects. For example, when a business rule is deleted, all
components that are attached to that business rule are deleted.
213 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.54.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesDelete operation.
3.1.4.54.1.1 BusinessRulesDeleteRequest
3.1.4.54.2 Elements
The following XML schema element definitions are specific to the BusinessRulesDelete operation.
3.1.4.54.2.1 BusinessRulesDeleteRequest
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the BusinessRulesDelete
operation.
3.1.4.54.3.1 BRDeleteCriteria
The BRDeleteCriteria complex type specifies lists of GUIDs for business rule items to be deleted.
The following is the XSD schema definition of the BRDeleteCriteria complex type.
<xs:complexType name="BRDeleteCriteria">
214 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.55 BusinessRulesGet
The BusinessRulesGet operation queries the existing business rules from an MDS repository. The
operation returns a representative data model of the business rule structure and content.
The BRGetCriteria complex type specifies the desired filters. Each parameter is optional, and those
that are specified are combined with AND logic.
The BRResultOptions complex type specifies the details that are desired in the output model.
ResultType defaults to "none" in each case. The returned BusinessRules type may contain collection
of business rules, condition tree nodes, conditions, and/or actions. Each property of the resulting
BusinessRules type is populated or not, according to the corresponding ResultType. A request
that does not specify at least one BRResultOption other than "none" results in an error, as this
does not provide any data.
<wsdl:operation name="BusinessRulesGet">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesGet" name="BusinessRulesGetRequest" message="tns:BusinessRulesGetRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesGetResponse" name="BusinessRulesGetResponse" message="tns:BusinessRulesGetResponse"
/>
</wsdl:operation>
3.1.4.55.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesGet operation.
3.1.4.55.1.1 BusinessRulesGetRequest
215 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.55.2 Elements
The following XML schema element definitions are specific to the BusinessRulesGet operation.
3.1.4.55.2.1 BusinessRulesGetRequest
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.55.2.2 BusinessRulesGetResponse
<xs:element name="BusinessRulesGetResponse">
<xs:complexType>
<xs:sequence>
<xs:element xmlns:q149="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="BusinessRuleSet" nillable="true" type="q149:BusinessRules" />
<xs:element xmlns:q150="http://schemas.microsoft.com/office/mdm/2007/11"
minOccurs="0" name="OperationResult" nillable="true" type="q150:OperationResult" />
</xs:sequence>
</xs:complexType>
</xs:element>
The following XML schema complex type definitions are specific to the BusinessRulesGet
operation.
216 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The BRGetCriteria complex type specifies GUIDs or names of the desired model, entity, or member
type.
The following is the XSD schema definition of the BRGetCriteria complex type.
<xs:complexType name="BRGetCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="AttributeId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="BusinessRuleIds" nillable="true"
type="tns:ArrayOfIdentifier" />
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="MemberType" type="tns:BREntityMemberType" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
ModelId: Specifies an identifier that specifies the GUID or the exact name of the model.
EntityId: Specifies an identifier that specifies the GUID or the exact name of the entity.
AttributeId: Specifies an identifier that specifies the GUID or the exact name of the attribute to
retrieve business rules that are related to the specified attribute.
BusinessRuleIds: Specifies an array of identifiers that specify the GUIDs of the business rules to
retrieve.
3.1.4.55.3.2 BRResultOptions
The BRResultOptions complex type specifies the desired format of the returned BusinessRules
type.
The following is the XSD schema definition of the BRResultOptions complex type.
<xs:complexType name="BRResultOptions">
<xs:sequence>
<xs:element minOccurs="0" name="BRActions" type="tns:ResultType" />
<xs:element minOccurs="0" name="BRConditionTreeNodes" type="tns:ResultType" />
<xs:element minOccurs="0" name="BRConditions" type="tns:ResultType" />
<xs:element minOccurs="0" name="BusinessRules" type="tns:ResultType" />
</xs:sequence>
</xs:complexType>
BRActions: Specifies a ResultType that controls the population of the BRActions property in
BusinessRules.
BRConditions: Specifies a ResultType that controls the population of the BRConditions property
in BusinessRules.
217 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.56 BusinessRulesPublish
The BusinessRulesPublish operation publishes business rule updates for a particular model,
entity, and member type.
The business rules are identified by Model, Entity, and MemberType using the BRPublishCriteria
complex type. Each parameter is optional, and multiple specified parameters are combined with an
AND to select business rules for publication. If no parameters are specified, all rules are published.
<wsdl:operation name="BusinessRulesPublish">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesPublish" name="BusinessRulesPublishRequest" message="tns:BusinessRulesPublishRequest"
/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesPublishResponse" name="MessageResponse" message="tns:MessageResponse" />
</wsdl:operation>
3.1.4.56.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesPublish
operation.
3.1.4.56.1.1 BusinessRulesPublishRequest
3.1.4.56.2 Elements
The following XML schema element definitions are specific to the BusinessRulesPublish operation.
3.1.4.56.2.1 BusinessRulesPublishRequest
218 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The following XML schema complex type definitions are specific to the BusinessRulesPublish
operation.
3.1.4.56.3.1 BRPublishCriteria
The following is the XSD schema definition of the BRPublishCriteria complex type.
<xs:complexType name="BRPublishCriteria">
<xs:sequence>
<xs:element minOccurs="0" name="EntityId" nillable="true" type="tns:Identifier" />
<xs:element minOccurs="0" name="MemberType" type="tns:BREntityMemberType" />
<xs:element minOccurs="0" name="ModelId" nillable="true" type="tns:Identifier" />
</xs:sequence>
</xs:complexType>
ModelId: Specifies an identifier for the model of the business rules to be published.
EntityId: Specifies an identifier for the entity of the business rules to be published.
MemberType: Specifies a member type within the entity of the business rules to be published.
3.1.4.57 BusinessRulesUpdate
The BusinessRulesUpdate operation updates existing business rules, conditions, or actions within
the MDS repository.
Business rule items in the request are matched to existing repository items by GUID only. Existing
GUIDs MUST be specified for items to be updated. Each GUID that is not found is returned as a
separate error.
Each item's update is attempted and committed as an individual transaction regardless of the failure
of other items. The operation does not complete a business rule name change that results in a
duplicate name within the same context.
A model of business rules or components for update is created by using the BRModel that contains
one or more BusinessRule data types. The BusinessRules data type includes placeholders for all
information about a business rule, including its descriptive and state information and its component
conditions and actions.
219 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="BusinessRulesUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesUpdate" name="BusinessRulesUpdateRequest" message="tns:BusinessRulesUpdateRequest" />
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Busin
essRulesUpdateResponse" name="MessageResponse" message="tns:MessageResponse" />
</wsdl:operation>
3.1.4.57.1 Messages
The following XSD schema message definitions are specific to the BusinessRulesUpdate operation.
3.1.4.57.1.1 BusinessRulesUpdateRequest
3.1.4.57.2 Elements
The following XML schema element definitions are specific to the BusinessRulesUpdate operation.
3.1.4.57.2.1 BusinessRulesUpdateRequest
</xs:sequence>
</xs:complexType>
</xs:element>
3.1.4.58 SecurityPrincipalsUpdate
220 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsdl:operation name="SecurityPrincipalsUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsUpdate" name="SecurityPrincipalsRequest" message="tns:SecurityPrincipalsRequest"
/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrincipalsUpdateResponse" name="MessageResponse" message="tns:MessageResponse" />
</wsdl:operation>
3.1.4.59 SecurityPrivilegesCreate
The SecurityPrivilegesCreate operation creates a new security privilege for a security principal in
the MDS repository. The SecurityPrivilegesCreate operation returns a standard MessageResponse
message.
<wsdl:operation name="SecurityPrivilegesCreate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesCreate" name="SecurityPrivilegesRequest" message="tns:SecurityPrivilegesRequest"
/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesCreateResponse" name="SecurityCreateResponse"
message="tns:SecurityCreateResponse" />
</wsdl:operation>
3.1.4.60 SecurityPrivilegesUpdate
<wsdl:operation name="SecurityPrivilegesUpdate">
<wsdl:input
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesUpdate" name="SecurityPrivilegesRequest" message="tns:SecurityPrivilegesRequest"
/>
<wsdl:output
wsaw:Action="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09/IService/Secur
ityPrivilegesUpdateResponse" name="MessageResponse" message="tns:MessageResponse" />
</wsdl:operation>
3.1.4.61 ServiceCheck
The ServiceCheck operation provides a check on the current availability of the MDS service. The
ServiceCheck operation returns a standard MessageResponse message.
221 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
3.1.4.61.1 Messages
3.1.4.61.2 Elements
The following XML schema element definitions are specific to the ServiceCheck operation.
3.1.4.61.2.1 ServiceCheckGetRequest
<xs:element name="ServiceCheckGetRequest">
<xs:complexType>
<xs:sequence />
</xs:complexType>
</xs:element>
None.
None.
222 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
In the following example, a client sends a MetadataCreate request message that is populated with a
model. This request could also contain the following:
Entity
Attributes
Explicit hierarchies
Derived hierarchy
Attribute groups
<httpRequest>
<headers>
<httpheader>
<name>Content-Type</name>
<value>text/xml; charset=utf-8</value>
</httpheader>
<httpheader>
<name>SOAPAction</name>
<value>http://tempuri.org/IService/MetadataCreate</value>
</httpheader>
</headers>
<body>
<a:Model>
<a:Identifier>
<a:Id>91356739-5271-4162-848d-03fe56549ea2</a:Id>
<a:Name>Product</a:Name>
<a:InternalId>7</a:InternalId>
</a:Identifier>
</a:Model>
</body>
<method>POST</method>
<code>0</code>
</httpRequest>
<httpResponse>
<headers>
<httpheader>
<name>Content-Type</name>
<value>text/xml; charset=utf-8</value>
</httpheader>
<httpheader>
223 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
In the following example, the client sends a BusinessRulesCreate request to create a new business
rule with the MDS system.
<operation>BusinessRulesCreate</operation>
<message>BusinessRulesCreateRequest</message>
- <httpRequest>
- <headers>
- <httpheader>
<name>Content-Type</name>
<value>text/xml; charset=utf-8</value>
</httpheader>
- <httpheader>
<name>SOAPAction</name>
<value>http://tempuri.org/IService/BusinessRulesCreate</value>
</httpheader>
</headers>
<body><?xml version="1.0" encoding="utf-8"?><soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header><International
xmlns="http://www.w3.org/2005/09/ws-i18n"><Locale>
1101</Locale><Tz><Tz></International></soap:Header><soap:Body><BusinessRulesCreateRequest
xmlns="http://tempuri.org/"> <businessRuleSet
xmlns:a="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09">
<a:BRActions/>
<a:BRConditionTreeNodes/>
<a:BRConditions/>
<a:BusinessRules>
<a:BusinessRule>
<a:AuditInfo i:nil="true"/>
<a:BRActions>
<a:BRAction>
<a:AuditInfo i:nil="true"/>
224 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
225 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
226 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
227 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
If the business rule is successfully created, the server responds with the following message.
<httpResponse>
<headers>
<httpheader>
<name>Content-Type</name>
<value>text/xml; charset=utf-8</value>
228 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
229 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
230 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
231 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
232 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
233 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
The server might be returning potentially sensitive data in its responses. Therefore, it is strongly
recommended that the server be configured to use GSS-API based encryption over TCP or Secure
Sockets Layer (SSL) over HTTPS to ensure the integrity of the data and to prevent tampering and
unauthorized access.
There are two strategies for reducing the impact of denial-of-service (DOS) attacks against the
server. These strategies are as follows:
Authentication is enabled, and access is denied to unauthenticated clients. This process allows a
user to quickly disable access to rogue client machines. Authentication is always enabled for the
MDS service.
No single request takes too much processing time on the server. This ensures that any attacker
must keep up a steady stream of requests to deny access to the server. Therefore, a simple
network trace allows the attacking machine to be identified and shut down. This process applies
to requests that are sent by "spoof clients" (for example, a virus that emulates a client. This virus
might try to pass an unbounded request or a long-running MDX query).
None.
234 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
For ease of implementation, the full WSDLs and schemas are provided in the following sections.
235 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
236 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
237 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
238 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
239 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
240 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
241 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
242 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
243 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
244 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
245 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
246 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
247 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
248 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
249 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
250 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
251 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
252 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
253 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
254 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
255 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
256 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
257 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
258 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
259 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
260 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
261 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
262 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
263 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
264 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
265 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
266 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
267 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
268 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
269 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
270 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
271 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
272 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
273 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
274 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
275 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
276 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
277 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
278 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
279 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
280 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
281 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
282 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
283 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
284 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
285 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
286 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
287 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
288 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
289 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
290 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
291 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
292 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
293 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
294 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
295 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
296 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
297 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
298 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
299 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
300 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
301 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
302 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
303 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
304 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
305 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
306 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
307 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
308 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
309 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
310 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
311 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
312 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
313 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
314 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
315 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
316 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
317 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
318 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
319 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
320 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
321 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
322 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
323 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
324 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
325 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
326 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
327 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
328 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
329 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
330 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
331 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
332 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
333 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
334 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
335 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
336 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
337 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
338 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
339 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
340 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
341 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
342 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
343 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
344 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
<wsa10:Address>http://brenmc3.redmond.corp.microsoft.com/MDS_mpc1/service/Service.svc</wsa10:
Address>
<Identity xmlns="http://schemas.xmlsoap.org/ws/2006/02/addressingidentity">
<Upn>[email protected]</Upn>
</Identity>
</wsa10:EndpointReference>
</wsdl:port>
<wsdl:port name="BasicHttpBinding_IService" binding="tns:BasicHttpBinding_IService">
<soap:address
location="http://brenmc3.redmond.corp.microsoft.com/MDS_mpc1/service/Service.svc/bhb" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
345 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
346 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
347 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
348 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
349 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
350 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
351 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
352 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
353 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
354 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
355 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
356 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
357 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
358 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
359 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
360 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
361 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
362 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
363 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
364 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
365 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
366 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
367 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
368 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
369 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
370 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
371 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
372 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
373 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
374 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
375 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
376 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
377 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
378 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
379 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
380 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
381 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
382 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
383 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
384 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
385 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
386 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
387 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
388 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
389 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
390 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
391 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
392 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
393 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
394 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
395 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
396 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
397 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
398 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
399 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
400 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
401 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
402 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
403 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
404 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
405 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
406 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
407 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
408 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
409 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
410 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
411 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
412 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
413 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
414 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
415 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
416 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
417 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
418 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
419 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
420 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
421 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
422 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
423 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
424 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
425 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
426 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
427 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
428 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
429 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
430 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
431 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
432 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
433 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
434 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
435 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
436 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
437 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
438 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
439 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
440 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
441 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
442 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
443 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
444 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
445 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
446 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
447 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
448 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
449 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
450 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
451 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
452 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
453 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
454 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
455 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
456 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
457 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
458 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
459 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
460 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
461 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
Exceptions, if any, are noted below. If a service pack or Quick Fix Engineering (QFE) number
appears with the product version, behavior changed in that service pack or QFE. The new behavior
also applies to subsequent service packs of the product unless otherwise specified. If a product
edition appears with the product version, behavior is different in that product edition.
Unless otherwise specified, any statement of optional behavior in this specification that is prescribed
using the terms SHOULD or SHOULD NOT implies product behavior in accordance with the SHOULD
or SHOULD NOT prescription. Unless otherwise specified, the term MAY implies that the product
does not follow the prescription.
462 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
463 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
464 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
465 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
466 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
467 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification
User type 81
468 / 468
[MS-SSMDSWS] — v20111108
Master Data Services Web Service Specification