Skip to main content
Pentaho Documentation

Data Source Wizard Resource

Overview

This service allows for listing, download, and removal of DSW data sources in the BA Platform.

Overview

This service allows for listing, download, and removal of DSW data sources in the BA Platform.

The following resources are applicable:

/data-access/api/datasource/dsw/domain

GET

Get the DSW datasource IDs.

Example Request:
GET pentaho/plugin/data-access/api/datasource/dsw/domain

Response Body

element: List
media types: application/xml
application/json

JaxbList<string> of DSW datasource IDs

Example Response:

{
"Item": [
{
"@type": "xs:string",
"$": "jmeter-dsw-pentaho-test.xmi"
}
]
}

/data-access/api/datasource/dsw/domain/{dswId }

GET

Export the DSW data source for the given DSW ID. The response will be zipped if there is more than one file. The response will contain an XMI and/or a mondrian cube definition file.

Example Request:
GET pentaho/plugin/data-access/api/datasource/dsw/domain/jmeter-dsw-pentaho-test.xmi

Parameters

name description type
dswId The id of the DSW datasource to export path

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

A Response object containing the encrypted DSW data source files.

Example Response:

An encrypted .XMI file or a .zip with encoded .XMI files

Status Codes

code description
200 DSW datasource export succeeded.
401 User is not authorized to export DSW datasource.
500 Failure to export DSW datasource.

DELETE

Remove the DSW data source for a given DSW ID.

Example Request:
DELETE pentaho/plugin/data-access/api/datasource/dsw/domain/jmeter-dsw-pentaho-test.xmi/remove

Parameters

name description type
dswId The id of the DSW datasource to remove path

Response Body

element: (custom)
media types: */*
application/xml
application/octet-stream

A 200 response code representing the successful removal of the DSW datasource.

Example Response:

This response does not contain data.

Status Codes

code description
200 DSW datasource removed successfully.
401 User is not authorized to remove DSW datasource.

Copyright © Pentaho.com
Generated by Enunciate.