Getting the Configuration Formats

Usage

Gets a list of all declared formats on the Web Intelligence Server for the default locale. Returns the list of default formats and available formats.

The results depends on the Preferred Viewing Locale (PVL). If you need a specific locale setting, the locale must be passed in the header of the HTTP request. See Supporting Multiple Languages.

Request

GET /configuration/formats

Response

Response type: application/xml or application/json

Response body:

<format default="Boolean" type="Number|Currency|DateTime|Boolean|Date|Time" sample="string">
    <template positive="string"/>

Where:

  • default is true if it is a default format
  • type is the type of any format
  • sample is a sample value of the corresponding format

Example

<formats> 
    <format default="true" type="Number" sample="1 234,57"> 
        <template positive=""/>    
    </format>    
    <format default="true" type="Currency" sample="1 234,57 €; -1 234,57 €"> 
        <template positive="#,##0.00' €'"/>    
    </format>
    <format default="true" type="DateTime" sample="21/09/2004 20:45:30">
        <template positive="dd'/'MM'/'yyyy HH':'mm':'ss"/> 
    </format>    
    <format default="true" type="Boolean" sample="vrai; faux">
        <template positive="BOOLEAN"/>
    </format>
    <format default="true" type="Date" sample="21/09/2004">
        <template positive="dd'/'MM'/'yyyy"/>
    </format>
    <format default="true" type="Time" sample="20:45:30">
        <template positive="HH':'mm':'ss"/>
    </format>
    <format type="Number" sample="1 234,57">
        <template positive="STANDARD"/>   
    </format>
    <format type="Number" sample="1,234567E3">  
        <template positive="SCIENTIFIC"/>
    </format>
    <format type="Number" sample="1235; (1235)">
        <template positive="0" negative="(0)"/>
    </format>
    <format type="Number" sample="1234,57">   
         <template positive="0.00"/>  
    </format>
    <format type="Number" sample="1 235">
        <template positive="#,##0"/>  
    </format>
    <format type="Currency" sample="1 234,57 €; -1 234,57 €">
        <template positive="#,##0.00' €'"/>  
    </format>
    ...
    <format type="Percent" sample="123 456,70%">
        <template positive="#,##0.00[%]'%'"/>
    </format>
</formats>