analytics/schemas/moser/current/response.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!--
 Licensed Materials - Property of IBM

 IBM Cognos Products: moser

 (C) Copyright IBM Corp. 2015, 2019

 US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified" version="7.4">
	<xs:element name="validationMessage">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="location" type="xs:string">
					<xs:annotation>
						<xs:documentation>The module path that has indexing to locate the validated object or property</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="errorCode" type="xs:string">
					<xs:annotation>
						<xs:documentation>The error code corresponds to the message</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="msg" type="xs:string">
					<xs:annotation>
						<xs:documentation>The message that is shown to the user</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="severity" type="xs:string">
					<xs:annotation>
						<xs:documentation>The severity level of the rule (error, warning, or info)</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="ruleId" type="xs:string">
					<xs:annotation>
						<xs:documentation>The ID of the registered validation rule that generated the result</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="detailMsg" type="xs:string" minOccurs="0">
					<xs:annotation>
						<xs:documentation>The detailed message from the query engine</xs:documentation>
					</xs:annotation>
				</xs:element>
				<xs:element name="errorData" minOccurs="0">
					<xs:annotation>
						<xs:documentation>Arbitrary data produced by the validation rule to aid in further describing the result and to help quick fix handlers solve the problem</xs:documentation>
					</xs:annotation>
					<xs:complexType>
						<xs:sequence>
							<xs:element name="line" type="xs:string"/>
							<xs:element name="character" type="xs:string"/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>
				<xs:element name="type" type="xs:string">
					<xs:annotation>
						<xs:documentation>The type of the rule. This would allow for grouping of validation results that pertain to a particular area of interest, e.g. grouping all validation rules by type "expression"</xs:documentation>
					</xs:annotation>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	<xs:element name="feedback">
		<xs:complexType>
			<xs:sequence>					
				<xs:element name="data">
					<xs:annotation>
							<xs:documentation>The validation data presented to the user</xs:documentation>
						</xs:annotation>				
					<xs:complexType>
						<xs:sequence>
							<xs:element ref="validationMessage" minOccurs="0" maxOccurs="unbounded"/>
						</xs:sequence>
					</xs:complexType>
				</xs:element>	
				<xs:element name="msg" maxOccurs="unbounded">
					<xs:annotation>
						<xs:documentation>Statistics information about the validation process, such as elapsed time, total numbers of results, etc.</xs:documentation>
					</xs:annotation>
					<xs:complexType>
					<xs:sequence>
						<xs:element name="severity" type="xs:string">
							<xs:annotation>
								<xs:documentation>is it always info level?</xs:documentation>
							</xs:annotation>
						</xs:element>
						<xs:element name="text" type="xs:string">
							<xs:annotation>
								<xs:documentation>Example: Total number of warnings: 3, errors: 1</xs:documentation>
							</xs:annotation>
						</xs:element>
					</xs:sequence>
				</xs:complexType>
				</xs:element>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
		
	
</xs:schema>