analytics/sdk/MAResponse.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
Licensed Materials - Property of IBM 
IBM Cognos Products: mqp 
(C) Copyright IBM Corp. 2003, 2010 
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. 
-->
<xs:schema elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="ResponseRoot">
		<xs:annotation>
			<xs:documentation>The top level element</xs:documentation>
		</xs:annotation>
		<xs:complexType>
			<xs:sequence>
				<xs:element name="folder" type="folderType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="functionsRoot" type="functionsRootType" minOccurs="0"/>
				<xs:element name="queryItem" type="queryItemType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="queryItemFolder" type="queryItemFolderType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="querySubject" type="querySubjectType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="dimension" type="dimensionType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="measure" type="measureType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="level" type="levelType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:element name="hierarchy" type="hierarchyType" minOccurs="0" maxOccurs="unbounded"/>
				<xs:sequence>
					<xs:element ref="defaultLocale" minOccurs="0"/>
					<xs:element name="locales" type="localesType" minOccurs="0"/>
					<xs:element name="package" type="packageType" minOccurs="0">
						<xs:annotation>
							<xs:documentation>Package Name</xs:documentation>
						</xs:annotation>
					</xs:element>
					<xs:element name="decimalSeparator" type="decimalSeparatorType" minOccurs="0"/>
					<xs:element name="listSeparator" type="listSeparatorType" minOccurs="0"/>
					<xs:element name="modelSearchPath" type="modelSearchPathType" minOccurs="0">
						<xs:annotation>
							<xs:documentation>CM Model search path - specifies connection to the package</xs:documentation>
						</xs:annotation>
					</xs:element>
					<xs:element ref="effectiveLocale" minOccurs="0"/>
				</xs:sequence>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:complexType name="calculationType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Calculation element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
		<xs:attribute name="_path" type="xs:string" use="required"/>
		<xs:attribute name="usage" type="xs:boolean"/>
		<xs:attribute name="description" type="xs:string"/>
	</xs:complexType>
	<xs:complexType name="decimalSeparatorType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the decimalSeparator element. This will be '.' or ',' based on the authoring locale, specified in the request</xs:documentation>
		</xs:annotation>
		<xs:attribute name="value" type="xs:NMTOKEN" use="required"/>
	</xs:complexType>
	<xs:element name="defaultLocale" type="xs:string">
		<xs:annotation>
			<xs:documentation>Default locale specified in the model</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:element name="effectiveLocale" type="xs:string">
		<xs:annotation>
			<xs:documentation>Calculate based on the model supported locales</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:complexType name="filterType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Filter element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
		<xs:attribute name="_path" type="xs:string" use="required"/>
		<xs:attribute name="description" type="xs:string"/>
	</xs:complexType>
	<xs:complexType name="folderType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Folder element</xs:documentation>
		</xs:annotation>
		<xs:sequence minOccurs="0" maxOccurs="unbounded">
			<xs:element name="querySubject" type="querySubjectType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="folder" type="folderType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="calculation" type="calculationType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="filter" type="filterType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="dimension" type="dimensionType" minOccurs="0" maxOccurs="unbounded"/>
		</xs:sequence>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
		<xs:attribute name="_path" type="xs:string" use="required"/>
		<xs:attribute name="description" type="xs:string"/>
	</xs:complexType>
	<xs:complexType name="functionType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Function element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="tip" type="xs:string"/>
		<xs:attribute name="type">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="function"/>
					<xs:enumeration value="literal"/>
					<xs:enumeration value="operator"/>
					<xs:enumeration value="summary"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
		<xs:attribute name="syntax" type="xs:string"/>
		<xs:attribute name="parameterType">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="date"/>
					<xs:enumeration value="numeric"/>
					<xs:enumeration value="string"/>
					<xs:enumeration value="time"/>
					<xs:enumeration value="unknown"/>
					<xs:enumeration value="unlimited"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="functionsRootType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Function root element.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="group" type="groupType" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="groupType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the group element.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="function" type="functionType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="group" type="groupType" minOccurs="0" maxOccurs="unbounded"/>
		</xs:sequence>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="listSeparatorType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the listSeparator element. This will be either a comma(,) or semicolon (;). It depends on the authoringLocale that was specified on the request.</xs:documentation>
		</xs:annotation>
		<xs:attribute name="value" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:element name="locale">
		<xs:annotation>
			<xs:documentation>This will be one of the locales that is specified in the model</xs:documentation>
		</xs:annotation>
		<xs:simpleType>
			<xs:restriction base="xs:string">
				<xs:enumeration value="en-US"/>
				<xs:enumeration value="fr-fr"/>
			</xs:restriction>
		</xs:simpleType>
	</xs:element>
	<xs:complexType name="localesType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the locale element</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element ref="locale" maxOccurs="unbounded"/>
		</xs:sequence>
	</xs:complexType>
	<xs:complexType name="modelSearchPathType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the modelSearchPath element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="value" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="packageType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the package Element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="name" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="queryItemType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Query Item element</xs:documentation>
		</xs:annotation>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="bmtId" type="xs:string"/>
		<xs:attribute name="usage" use="required">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="0"/>
					<xs:enumeration value="2"/>
					<xs:enumeration value="3"/>
					<xs:enumeration value="7"/>
					<xs:enumeration value="attribute"/>
					<xs:enumeration value="fact"/>
					<xs:enumeration value="identifier"/>
					<xs:enumeration value="unknown"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
		<xs:attribute name="datatype">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="characterlength16"/>
					<xs:enumeration value="datetime"/>
					<xs:enumeration value="decimal"/>
					<xs:enumeration value="float64"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
		<xs:attribute name="promptType" type="xs:string"/>
		<xs:attribute name="unSortable" type="xs:boolean"/>
		<xs:attribute name="displayType" type="xs:string"/>
		<xs:attribute name="regularAggregate">
			<xs:simpleType>
				<xs:restriction base="xs:NMTOKEN">
					<xs:enumeration value="count"/>
					<xs:enumeration value="sum"/>
					<xs:enumeration value="unsupported"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:attribute>
		<xs:attribute name="promptCascadeOnRef" type="xs:string"/>
		<xs:attribute name="promptFilterItemRef" type="xs:string"/>
		<xs:attribute name="promptDisplayItemRef" type="xs:string"/>
		<xs:attribute name="promptUseItemRef" type="xs:string"/>		
		<xs:attribute name="_ref" type="xs:string"/>
		<xs:attribute name="name" type="xs:string"/>
		<xs:attribute name="_path" type="xs:string"/>
		<xs:attribute name="screenTip" type="xs:string"/>
		<xs:attribute name="description" type="xs:string"/>
	</xs:complexType>
	<xs:complexType name="queryItemFolderType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Query Item Folder element</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="queryItem" type="queryItemType" minOccurs="0" maxOccurs="unbounded"/>
		</xs:sequence>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
		<xs:attribute name="_path" type="xs:string" use="required"/>
	</xs:complexType>
	<xs:complexType name="querySubjectType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Query Subject element</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="QueryItem" type="queryItemType" minOccurs="0" maxOccurs="unbounded"/>
			<xs:element name="defaultLocale"/>
		</xs:sequence>
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string"/>
		<xs:attribute name="name" type="xs:string"/>
		<xs:attribute name="_path" type="xs:string"/>
		<xs:attribute name="description" type="xs:string"/>
		<xs:attribute name="bmtId" type="xs:string"/>
	</xs:complexType>
	<xs:complexType name="measureType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Measure element</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:extension base="queryItemType">
				<xs:sequence>
					<xs:element name="measure" type="measureType" minOccurs="0" maxOccurs="unbounded"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="levelType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the Level element</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:extension base="queryItemFolderType"/>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="memberType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the member element. Note: for custom properties, the attribute name will be custom property name.</xs:documentation>
		</xs:annotation>
		<xs:sequence>
			<xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
		</xs:sequence>
		<xs:attribute name="_ref" type="xs:string" use="optional"/>
		<xs:attribute name="_path" type="xs:string" use="optional"/>
		<xs:attribute name="memberUniqueName" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Unique name of the member.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="memberCaption" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>A user-friendly name for display purposes.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="levelUniqueName" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Unique name of the level.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="levelNumber" type="xs:unsignedInt" use="optional">
			<xs:annotation>
				<xs:documentation>Number of levels descended from root, starting at zero.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="parentUniqueName" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Name of parent. If null, the member has no parent.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="levelLabel" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Level label for the member.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="dimensionUniqueName" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Unique name of the dimension.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
		<xs:attribute name="hierarchyUniqueName" type="xs:string" use="optional">
			<xs:annotation>
				<xs:documentation>Unique name of the hierarchy.</xs:documentation>
			</xs:annotation>
		</xs:attribute>
	</xs:complexType>
	<xs:complexType name="hierarchyType">
		<xs:annotation>
			<xs:documentation>Defines the type used for the hierarchy element</xs:documentation>
		</xs:annotation>
		<xs:complexContent>
			<xs:extension base="objectType">
				<xs:sequence>
					<xs:element name="level" type="levelType" minOccurs="0" maxOccurs="unbounded"/>
					<xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
	<xs:complexType name="objectType">
		<xs:attribute name="ID" type="xs:string" use="required"/>
		<xs:attribute name="_ref" type="xs:string" use="required"/>
		<xs:attribute name="name" type="xs:string" use="required"/>
		<xs:attribute name="_path" type="xs:string" use="required"/>
		<xs:attribute name="description" type="xs:string" use="optional"/>
	</xs:complexType>
	<xs:complexType name="dimensionType">
		<xs:complexContent>
			<xs:extension base="querySubjectType">
				<xs:sequence>
					<xs:element name="member" type="memberType" minOccurs="0" maxOccurs="unbounded"/>
					<xs:choice>
						<xs:choice minOccurs="0" maxOccurs="unbounded">
							<xs:element name="level" type="levelType"/>
							<xs:element name="hierarchy" type="hierarchyType"/>
						</xs:choice>
						<xs:element name="measure" type="measureType" minOccurs="0" maxOccurs="unbounded"/>
					</xs:choice>
				</xs:sequence>
			</xs:extension>
		</xs:complexContent>
	</xs:complexType>
</xs:schema>