Getting the Details of a Data Provider

Gets the details of a data provider for a Web Intelligence document.

Request

GET <webiURL>/documents/{documentId}/dataproviders/{dataProviderId}

Where:

  • {documentId} is the document identifier
  • {dataProviderId} is the identifier of the data provider available for a document
Response

Response type: application/xml or application/json

Response body: the details of the data provider, with:

  • <id>
  • <name>
  • <dataSourceId>
  • <dataSourceType> (unx, unv, bex, excel, or fhsql)
  • <dataSourcePrefix>, used as prefix for data source object IDs of .unv universes only
  • <updated>, the date and time of the last update
  • <ispartial>
  • <rowCount>, the number of rows
  • The object dictionary, with:
    • <id>
    • <name>
    • <description>
    • <dataSourceObjectId>
    • <formulaLanguageId>, used as key for data filters
  • The query identifier
  • The properties of the data provider if any

Example

GET <webiURL>/documents/18809/dataproviders/DP0

XML response:

<dataprovider>
    <id>DP0</id>
    <name>Query 1</name>
    <dataSourceId>7599</dataSourceId>
    <dataSourceType>bex</dataSourceType>
    <dataSourcePrefix>DS0</dataSourcePrefix>
    <updated>2012-07-31T15:44:25.000+02:00</updated>	
    <duration>1</duration>
    <isPartial>false</isPartial>
    <rowCount>284</rowCount>
    <flowCount>1</flowCount>
    <dictionary>
        <expression dataType="String" qualification="Dimension">
            <id>DP1.DO1</id>
            <name>City</name>
            <description>City</description>  
            <dataSourceObjectId>AZ_CITY</dataSourceObjectId> 
            <formulaLanguageId>[City]</formulaLanguageId> 
        </expression>  
        <expression dataType="String" qualification="Dimension">
            <id>DP1.DO1d</id> 
            <name>Customer</name>  
            <description>Customer</description>  
            <dataSourceObjectId>AZ_CUSTOM</dataSourceObjectId>  
            <formulaLanguageId>[Query 2].[Customer]</formulaLanguageId> 
        </expression>  
        <expression dataType="String" qualification="Dimension"> 
            <id>DP1.DO6</id>
            <name>Sales Person</name>
            <description>Sales Person</description>
            <dataSourceObjectId>AZ_SALES</dataSourceObjectId>
            <formulaLanguageId>[Query 2].[Sales Person]</formulaLanguageId>
        </expression>  
        <expression dataType="Numeric" qualification="Measure"> 
            <id>DP1.DO5c</id> 
            <name>Order Amount</name>
            <description>Order Amount</description> 
            <dataSourceObjectId>MCWZZCK8Z39ES5HKKFA52FG78E</dataSourceObjectId> 
            <formulaLanguageId>[Query 2].[Order Amount]</formulaLanguageId> 
        </expression>  
        <expression dataType="Numeric" qualification="Measure"> 
            <id>DP1.DO5f</id>  
            <name>Order Quantity</name>  
            <description>Order Quantity</description>  
            <dataSourceObjectId>M7MRKCICEBY5WYKQ8AL86VY9Q8</dataSourceObjectId>  
            <formulaLanguageId>[Query 2].[Order Quantity]</formulaLanguageId> 
        </expression> 
    </dictionary>
    <query>CgASFQoGWl9DSVRZEgsKB0FaX0NJVFkQARIXCgdaX1NBTEVTEgwKCEFaX1NBTEVTEAES
        GQoIWl9DVVNUT00SDQoJQVpfQ1VTVE9NEAEaSwoZQ1daWkNLOFozOUVTNUhLS0ZBNTJGRzc
        4RRIMT3JkZXIgQW1vdW50GAIiHgoaTUNXWlpDSzhaMzlFUzVIS0tGQTUyRkc3OEUQBhpNCh
        k3TVJLQ0lDRUJZNVdZS1E4QUw4NlZZOVE4Eg5PcmRlciBRdWFudGl0eRgCIh4KGk03TVJLQ
        0lDRUJZNVdZS1E4QUw4NlZZOVE4EAYgACgAMAE=</query>  
</dataprovider>

JSON response:

{"dataprovider":
    {"id":"DP2","name":"Query 3","dataSourceId":6120,"dataSourceType":"bex",
        "dataSourcePrefix":"DS0", "updated":"2014-04-23T09:08:20.000+02:00",
        "duration":1,"isPartial":false, "rowCount":175,"flowCount":1,
        "dictionary":
            {"expression":
                [{"@dataType":"String","@qualification":"Hierarchy","id":"DP2.DO5",
                    "name":"Region","description":"Region","dataSourceObjectId":
                    "HZ_REGION", "formulaLanguageId":"[Region]"},
                 {"@dataType":"String","@qualification":"Attribute","id":"DP2.DOa",
                    "name":"Order Amount Currency","description":"",
                    "dataSourceObjectId":"MDCZO1XT12V8KC6LFFGN1WEL3E.Currency",
                    "formulaLanguageId":"[Order Amount Currency]"}
                ]
            },
        "query":"CgASGQoIWl9SRUdJT04SDQoJSFpfUkVHSU9OEAIaVAoZRENaTzFYVDEyVjhLQzZMRkZ
            HTjFXRUwzRRIMT3JkZXIgQW1vdW50GAIiJwojTURDWk8xWFQxMlY4S0M2TEZGR04xV0VMM0U
            uQ3VycmVuY3kQCCAAKAAwAA=="
    }
}

XML response in the case of a Microsoft Excel spreadsheet:

<dataprovider> 
    <id>DP3</id>  
    <name>MyQuery</name>  
    <dataSourceId>6641</dataSourceId>  
    <dataSourceType>excel</dataSourceType>  
    <updated>2014-04-29T13:37:24.000+02:00</updated>  
    <duration>1</duration>  
    <isPartial>false</isPartial>  
    <rowCount>405</rowCount>  
    <dictionary> 
        <expression dataType="String" qualification="Dimension"> 
            <id>DP3.DO7</id>  
            <name>Build</name>  
            <description/>  
            <dataSourceObjectId>DS3.DO7</dataSourceObjectId>  
            <formulaLanguageId>[Build]</formulaLanguageId> 
        </expression>  
        <expression dataType="String" qualification="Dimension"> 
            <id>DP3.DO0</id>  
        ...
    </dictionary>  
    <properties> 
        <property key="selectedSheet">Planning</property>  
        <property key="rangeSelectionMode">all</property>  
        <property key="firstRawAsObjectNames">true</property>
        <property key="isRefreshable">true</property> 
    </properties> 
</dataprovider>

XML response in the case of a free-hand SQL script:

<dataprovider>
    <id>DP5</id>  
    <name>FreeHandSQL based on beachOraJdbc</name>  
    <dataSourceId>6250</dataSourceId>  
    <dataSourceType>fhsql</dataSourceType>  
    <updated>2014-08-29T08:43:26.000+02:00</updated>  
    <duration>1</duration>  
    <isPartial>false</isPartial>  
    <rowCount>7</rowCount>  
    <flowCount>1</flowCount>  
    <dictionary> 
        <expression dataType="Numeric" qualification="Measure"> 
            <id>DP5.DO0</id>  
            <name>COUNTRY_ID</name>  
            <dataSourceObjectId>DS5.DO0</dataSourceObjectId>  
            <formulaLanguageId>[COUNTRY_ID]</formulaLanguageId>  
            <aggregationFunction>None</aggregationFunction> 
        </expression>  
        <expression dataType="String" qualification="Dimension"> 
            <id>DP5.DO1</id>  
            <name>COUNTRY</name>  
            <dataSourceObjectId>DS5.DO1</dataSourceObjectId>  
            <formulaLanguageId>[COUNTRY]</formulaLanguageId> 
        </expression> 
    </dictionary>  
    <properties> 
        <property key="sql">SELECT * from country</property>  
        <property key="maxRows">-1</property>  
        <property key="timeout">-1</property> 
    </properties> 
</dataprovider>