Schema file elements for getting the results of a column analysis

Name of the XSD file where the elements are defined

Commands that use these elements

GET columnAnalysis/results

Example of an XML document for the GET columnAnalysis command:

<?xml version="1.0" encoding="UTF-8"?>
<iaapi:Project xmlns:iaapi="http://www.ibm.com/investigate/api/iaapi" 
   name="project1">
  <DataSources>
    <DataSource name="SOURCE1">
      <Schema name="SCHEMA1">
        <Table name="TABLE1">
          <Column name="COL1">
            <ColumnAnalysisResults>
              <RuntimeMetadata sampleUsed=”true” whereClause=”GENDER='M'”
                      analysisDate=”2010-02-09T18:56:31+01:00” runTime=”120”>
                <SampleOptions type=”RANDOM” percent=”0.10” size=”100”/>
              </RuntimeMetadata>
              <Cardinality count=”1000” percent=”1.0” 
                      inferredCardinalityType=”UNIQUE”
                      maxValue="1900-01-01 23:41:00.000000" 
                      minValue="1900-01-01 00:01:00.000000" 
                      definedCardinalityType=”NOT_CONSTRAINED” 
                      selectedCardinalityType=”UNIQUE”
                      sequence="4" 
                      totalRows="1000" />
              <DataType definedType=”STRING” definedLength=”128”
                      inferredType=”STRING” inferredLength=”32”
                      selectedType=”STRING” selectedLength=”32”
                      definedNullability=”true” inferredNullability=”true”
                      selectedNullability=”true”
                      definedIsEmpty=”false” inferredIsEmpty=”false” 
                      selectedIsEmpty=”false”
                      inferredIsConstant=”false” definedIsConstant=”false”/>
              <DataClass classificationDate=”2010-02-09T18:56:31+01:00”
                      classificationStatus=”REVIEWED”
                      inferredClass=”Code”
                      selectedClass=”Code”/>
              <Format analysisDate=”2010-02-09T18:56:31+01:00” 
                      analysisStatus=”REVIEWED”
                      generalFormat=”AAAA” generalFormatPercent=”0.95”/>
              <CompletenessAnalysis analysisDate=”2010-02-09T18:56:31+01:00”
                      analysisStatus=”REVIEWED”/>
              <DomainAnalysis analysisDate=”2010-02-09T18:56:31+01:00”
                      analysisStatus=”REVIEWED”/>
             <Notes>
               <Note status="Opened" subject="Column Notes" textContent="This is
                  notes for the column" type="Action"/>
               </Notes>
             <Terms>
               <Term name="Category1/Term1"/>
               <Term name="Category1/Term2"/>
             </Terms>
            </ColumnAnalysisResults>
          </Column>
          <Column name="COL2">
            <ColumnAnalysisResults>
              (…)
            </ColumnAnalysisResults>
          </Column>
        </Table>
      </Schema>
    </DataSource>
  </DataSources>
</iaapi:Project>

XSD file elements

<Project name=”...”>

Specifies the name of the project.

The following table shows the attributes of the <Project> element:

The following table shows the children of the <Project> element:

<Column name=”...”>

Specifies a physical column to register in a physical or virtual table that is defined in a project.

The following table shows the attributes of the <Column> element:

The following table shows the children of the <Column> element:

The following table shows the children of the <ColumnAnalysisResults> element:

<Cardinality>

Specifies the number of values in a column.

The following table shows the attributes of the <Cardinality> element:

<DataType>

Specifies the defined, inferred, and selected data types.

The following table shows the attributes of the <DataType> element:

<DataClass>

Specifies the inferred and selected data classes.

The following table shows the attributes of the <DataClass> element:

<Format>

Represents the most frequent inferred format of a column.

The following table shows the attributes of the <Format> element:

<CompletenessAnalysis>

Specifies the last completeness analysis run.

The following table shows the attributes of the <CompletenessAnalysis> element:

<DomainAnalysis>

Specifies the last domain analysis run.

The following table shows the attributes of the <DomainAnalysis> element:

<FrequencyDistribution>

Specifies the number of occurrences of each distinct data value of a column.

The following table shows the attributes of the <FrequencyDistribution> element:

The following table shows the children of the <FrequencyDistribution> element:

<Value>

Specifies the frequency and percentage of a particular distinct value.

The following table shows the attributes of the <Value> element: