Adds a new data provider to a Web Intelligence document.
You can add:
POST <webiURL>/documents/{documentId}/dataproviders
Where:
Request body:
<dataprovider> <name> <dataSourceId>
Where:
In the case of a Microsoft Excel spreadsheet, you may add the following <property> elements to provide supplementary details on the data source.
<properties> <property key="selectedSheet"> <property key="rangeSelectionMode"> <property key="firstRowAsObjectNames"> <property key="selectedRange">
Property Key | Description |
---|---|
selectedSheet | Specifies the name of the sheet to be used as data provider. The first sheet is used if the property is not set. |
rangeSelectionMode | Can be:
|
firstRowAsObjectNames | Boolean. Default is true. If true, the first row of the sheet contains column names. |
selectedRange | Do not use it if rangeSelectionMode is set to
all. Specify one of the named cell ranges if
any, or use the end-user input. Note The present release does not
suppot fragmented named ranges.
|
<dataprovider> <name> <dataSourceId> <properties> <property key="sql">
All SQL statements conform to standards ANSI-SQL 89/92/98 are supported. For example, SET options, stored procedures, and WITH clauses are supported. The @variable and @prompt functions for interactive queries are also supported. A SQL script containing DDL commands such as DROP TABLE or ALTER TABLE is not executed.
You may also add the following <property> elements to provide supplementary details on the desired results:
<properties> <property key="maxRows"> <property key="timeout">
Property Key | Description |
---|---|
maxRows | Specifies the maximum rows retrieved. If not set or value is -1, the property is disabled. |
timeout | Specifies the maximum retrieval time (in seconds). If not set or value is -1, the property is disabled. |
Response type: application/xml or application/json
The response is a message stating the success or failure of the request.
POST <webiURL>/documents/3422/dataproviders
Request body for a BEx query:
<dataprovider> <name>Query1</name> <dataSourceId>11990;Z_BOBJ;AAQUERY_SAMPLE</dataSourceId> <dataprovider>
Request body for a Microsoft Excel spreadsheet:
<dataprovider> <name>My Excel data provider</name> <dataSourceId>6641</dataSourceId> <properties> <property key="selectedSheet">mysheet</property> <property key="rangeSelectionMode">freehand</property> <property key="firstRowAsObjectNames">true</property> <property key="selectedRange">A2:F7</property> </properties> <dataprovider>
Request body for a free-hand SQL script:
<dataprovider> <name>FHSQL dp on beachOraJdbc</name> <dataSourceId>6250</dataSourceId> <properties> <property key='sql'>SELECT * from country</property> <property key='maxRows'>286</property> <property key='timeout'>857</property> </properties> </dataprovider>
Response:
<success> <message>The resource of type 'Data provider' with identifier 'DP3' has been successfully created.</message> <id>DP3</id> </success>