JDBC Driver for REST

Build 22.0.8462

XMLFormat

Specifies the format of the XML document.

Possible Values

XML, XMLTABLE

Data Type

string

Default Value

"XML"

Remarks

The following XMLFormat configurations are available.

  • XML

    This is the default format and should be used in the majority of cases. The element or attribute name containing each value is used as the column name for that value.

  • XMLTable

    This format is for when the column name is separate from the data contained in that column. This is useful when the element or attribute containing the data has a generic name (like "Value") instead of being specific to each column.

    Note: DataModel does not apply when using this XMLFormat.

    Example:

        <Report>
          <Table>
              <Row>
                  <Value label="Customer">Mark Rodgers</Value>
                  <Value label="SupportCost">89.28</Value>
                  <Value label="ContractValue">299.99</Value>
              </Row>
              <Row>
                  <Value label="Customer">Hank Howards</Value>
                  <Value label="SupportCost">225.63</Value>
                  <Value label="ContractValue">0.00</Value>
              </Row>
          </Table>
        </Report>
      

    The XPath property requires special syntax to identify the column and row paths. Each path is given with a prefix depending on the type of path. All of the following are required:

    • row: This is the XPath of the element that contains each row's data. In the above example, this is: row:/Report/Table/Row
    • name: This is the XPath of the element containing the column name. In the above example, this is: column:/Report/Table/Row/Value@label
    • value: This is the XPath of the element that contains each column's data inside the row. In the above example, this is: value:/Report/Table/Row/Value

    Each of these paths is separated by a semicolon, so the complete XPath for the above example is: row:/Report/Table/Row;name:/Report/Table/Row/Value@label;value:/Report/Table/Row/Value

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462