Data Provider URLs

This is a reference to the URLs available to work with queries in reports.

In the tables below are indicated the 4.0 and/or 4.1 releases from which each call is supported. The URL must be used with the default base URL value: <webiURL>.

Table 1: Data Providers
Action Method URL Release
Getting the List of Data Providers GET /documents/{documentId}/dataproviders 4.0 SP5 | 4.1
Getting the Details of a Data Provider GET /documents/{documentId}/dataproviders/{dataproviderId} 4.0 SP5 | 4.1
Adding a Data Provider POST /documents/{documentId}/dataproviders 4.0 SP6 | 4.1
Moving a Data Provider in a Document PUT /documents/{documentId}/dataproviders?fromId={DPn}&toId={DPx} 4.0 SP6 | 4.1
Updating a Data Provider PUT /documents/{documentId}/dataproviders/{dataproviderId} 4.0 SP5 | 4.1
Deleting a Data Provider DELETE /documents/{documentId}/dataproviders/{dataproviderId} 4.0 SP6 | 4.1
Getting the Flow Count of a Data Provider GET /documents/{documentId}/dataproviders/{dataproviderId}/flows/count 4.0 SP5 | 4.1
Getting the Details of a Flow GET /documents/{documentId}/dataproviders/{dataproviderId}/flows/{flowId} 4.0 SP5 | 4.1
Getting the Samples of a Flow GET /documents/{documentId}/dataproviders/{dataproviderId}/flows/{flowId}/samples 4.1 SP5
Getting the Query Plan GET /documents/{documentId}/dataproviders/{dataproviderId}/queryplan 4.1 SP4
Updating the Query Plan PUT /documents/{documentId}/dataproviders/{dataproviderId}/queryplan 4.1 SP4
Getting the Query Specification GET /documents/{documentId}/dataproviders/{dataproviderId}/specification 4.0 SP6 | 4.1
Updating the Query Specification PUT /documents/{documentId}/dataproviders/{dataproviderId}/specification 4.0 SP6 | 4.1
Table 2: Personal Data Providers
Action Method URL Release
Uploading an Excel Spreasheet to the CMS Repository POST /spreadsheets 4.1 SP5
Getting the List of Excel Spreadsheets GET /spreadsheets 4.1 SP5
Getting the Details of an Excel Spreadsheet GET /spreadsheets/{spreadsheetId} 4.1 SP5
Table 3: Free-Hand SQL Data Providers
Action Method URL Release
Getting the List of Connections GET /connections 4.1 SP5
Getting the Details of a Connection GET /connections/{connectionId} 4.1 SP5
Table 4: Change Data Sources
Action Method URL Release
Getting the Proposal Mappings GET /documents/{documentId}/dataproviders/{dataproviderId}/mappings?originDataproviderIds={DP1Id},{DP2Id}&targetDatasourceId={DatasourceId} 4.0 SP6 | 4.1
Updating the Mappings POST /documents/{documentId}/dataproviders/{dataproviderId}/mappings?originDataproviderIds={DP1Id},{DP2Id}&targetDatasourceId={DatasourceId} 4.0 SP6 | 4.1
Table 5: Refresh Data Providers
Action Method URL Release
Getting the Refresh Parameters of a Data Provider GET /documents/{documentId}/dataproviders/{dataproviderId}/parameters 4.1 SP5
Refreshing a Data Provider PUT /documents/{documentId}/dataproviders/{dataproviderId}/parameters 4.1 SP5